Add comment and commit-log style guidelines#898
Conversation
yungyuc
added
refactor
yungyuc
left a comment
yungyuc
left a comment
There was a problem hiding this comment.
@tigercosmos please take a look.
| follows the same economy as the rest of the guide -- a comment that merely | ||
| restates the code is noise, and noise is removed. | ||
|
|
||
| We write comments clearly and concisely. Comments must not interfere |
There was a problem hiding this comment.
Clear and concise comments.
There was a problem hiding this comment.
I usually also add a "short" keyword.
There was a problem hiding this comment.
Conciseness is better than shortness.
| Write it for the person who runs `git log` or `git blame` a year from now. We | ||
| do not use semantic (conventional) commit prefixes such as `feat:` or `fix:`. | ||
|
|
||
| We write comments clearly and concisely, like carefully-thinking professionals |
There was a problem hiding this comment.
Clear and concise commit logs.
tigercosmos
left a comment
tigercosmos
left a comment
There was a problem hiding this comment.
@yungyuc I added a few comments.
| follows the same economy as the rest of the guide -- a comment that merely | ||
| restates the code is noise, and noise is removed. | ||
|
|
||
| We write comments clearly and concisely. Comments must not interfere |
There was a problem hiding this comment.
I usually also add a "short" keyword.
| that cannot fail when the logic it covers changes is not pulling its weight. | ||
|
|
||
| ## Integer Type | ||
| ## Comments |
There was a problem hiding this comment.
The style file is getting pretty large now. I’m a bit concerned that AI agents may not be able to read or follow it reliably. We probably need to refactor it into a more structured layout.
There was a problem hiding this comment.
I tighten it a little bit. Comments are important part of code. Coders must be aware of the guideline.
2 participants
Add two sections in
STYLE.md: comment guideline and commit log guideline.[skip-ci]