Skip to content

Commit 370cfcb

Browse files
committed
chore(instructions): add rules to avoid comments, favoring intent revealing names
1 parent e1588f2 commit 370cfcb

1 file changed

Lines changed: 5 additions & 0 deletions

File tree

.github/copilot-instructions.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,11 @@ Task is NOT complete until all verification passes.
6262
- Keep cyclomatic complexity low
6363
- Remove all unused imports and variables
6464
- Run lint and tests after EVERY change
65+
- Never use code comments.
66+
Instead, refactor code to be self-explanatory.
67+
If you find yourself writing a comment, ask how you can change the code to eliminate the need for it.
68+
Extract functions, rename variables, or restructure code to make the intent clear without comments.
69+
6570

6671
## Testing Standards
6772

0 commit comments

Comments
 (0)