Commit 131fde8
authored
Create src.instructions.md with commenting rules (#2964)
This pull request adds a new instructions file that defines general
rules for commenting code within the `src` directory. The file outlines
best practices for writing comments, emphasizing that comments should
not restate code and should only be used when the code cannot express
the intent clearly.
Documentation and code quality guidelines:
* Added `.github/instructions/src.instructions.md` to specify general
rules for code comments, including when to use comments and when to
improve code to make comments unnecessary.2 files changed
+14
-1
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
183 | 183 | | |
184 | 184 | | |
185 | 185 | | |
186 | | - | |
| 186 | + | |
187 | 187 | | |
188 | 188 | | |
189 | 189 | | |
| |||
0 commit comments