Skip to content

AGENTS: Avoid parrot comment #3755

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

Merged
patrickelectric merged 1 commit into from
Feb 4, 2026
+1 −0
Merged

AGENTS: Avoid parrot comment #3755

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
1 change: 1 addition & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ When writing code:
- Use 120 character line length
- No docstrings unless the function is non-obvious
- No comments unless explaining "why", never "what"
- Don't do parrot comments. Do not comment something that just repeat what the code already says
- Preserve existing comments when refactoring code. Do not delete comments from code you haven't logically changed
- Prefer editing existing files over creating new ones
- Use optional chaining (`?.`) when possible in typescript
Expand Down