Skip to content

docs: add code comments guideline to agents guide #22

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

Open
aayushshah15 wants to merge 1 commit into
base: master
Choose a base branch
from
+4 −0
Open

docs: add code comments guideline to agents guide #22

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
4 changes: 4 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,10 @@ gofmt -w .
gofmt -w path/to/file.go
```

## Code Style

- **Comments**: Don't comment obvious code. Do add concise comments when the rationale (the "why") behind a decision isn't obvious from the code itself — e.g., non-obvious business rules, workarounds, performance trade-offs, or constraints that would require digging through history to understand

## Workflow Summary

1. Create a branch from `master`
Expand Down
Loading