Skip to content

Add guidance for short purpose comments on complex functions #276

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
0xroylee merged 1 commit into from
May 30, 2026
Merged

Add guidance for short purpose comments on complex functions #276

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
2 changes: 2 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,8 @@ stays scoped, and ends with evidence the next session can trust.
speculative configurability, abstractions, or adjacent cleanup.
- Keep edits surgical. Every changed line should trace to the request, and any
unrelated dead code or risk should be mentioned instead of silently refactored.
- For complex functions, add one short comment that describes the function's
purpose.
- Define success criteria and verification before or during implementation, then
loop until the relevant checks pass or a blocker is explicit.

Expand Down
Loading