Extend Copilot code review guidelines - #11904
Conversation
|
Claude finished @stephanos's task in 1m 51s —— View job Reviewed 1 file, 3 findings. |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
chrsmith
left a comment
chrsmith
left a comment
There was a problem hiding this comment.
Needs a PR description, of course ;) But these updates all look good to me. Though I left one opinion as a comment.
|
|
||
| ## 7. Code comments | ||
|
|
||
| - Write standalone comments as full sentences that start with a capital letter and end with punctuation. End-of-line comments may be sentence fragments. |
There was a problem hiding this comment.
I think this is a good rule to add, but I'd relax the language slightly. e.g. if you are using a comment to identify a stanza of code it doesn't need to be a complete sentence.
e.g.
...
// Validation
...
Or when writing a table driven test, having a comment to break up lists of things like // Positive tests. Arguably that is a complete sentence, but I don't think we want the AI to be nagging people about putting a period at the end of it.
How about: "For non-trivial comments..."?
There was a problem hiding this comment.
Yeah good point! Basically it should be saying "if it looks like a sentence, make it a sentence".
There was a problem hiding this comment.
I added some exceptions there now, we can adjust if it's overzealous.
2 participants
WISOTT