Skip to content

add instruction that TODOs should have an owner #13260

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
ShahakShama wants to merge 1 commit into from
Closed

add instruction that TODOs should have an owner #13260

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions style.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -395,6 +395,9 @@ Don't use abbreviations: use `cannot` (rather than `can't`), `transaction` (rath

In all comment types (including inline comments!) start comments with a capital letter and end with a dot.

When writing a TODO comment, always add an owner for that TODO inside the comment.
If it's not you, make sure the owner is aware of the TODO

### Textual Content Quality

All textual content, including code-comments, commit messages, `expect` messages (see also [Assertions](#assertions) section), should include _additional_ information not readily observable in the surrounding code. Take extra care when using AI-generated code, which tends to include a lot of trivial comment-bloat.
Expand Down
Loading