These rules must be honoured since breaking them causes serious problems. Rules are ordered by importance.
- DO NOT add AI attribution to any output(code, commits, PRs, docs, comments, etc.).
- DO NOT commit directly to main branches(main, master)
- DO Confirm explicitly before deleting code
- DO Ask user before making architectural decisions
Recommended practices for code quality and consistency. Follow when possible.
- Minimal comments - focus on "why" when necessary
- Minimal logging - only when meaningful
- No magic numbers or strings
- Use git as default Version Control System.
- Use imperative mood, no period at ending. 72 Characters in title, unlimited in details.
- Create small, focused commits grouping related changes.
- No revert commits in git tree.
- Code review fixes: amend to original commit (
git commit --fixup+git rebase --autosquash) - Update and rebase to base branch before pushing
- All changes must contain relevant test codes
- All fixes must be verifiable through test code
- Test names should describe the concern and/or specification (e.g., `xxx_should_yyy_when_zzz')
- 'xxx' is the target - System Under Test
- 'yyy' is the expected result
- 'zzz' is the given condition
- Changes should be self-explanatory through code, not comments
- Share plan first, get approval before execution
- Build must not fail upon PR creation
For environments with multiple agents on same repo.
- Don't modify shared git state without explicit request:
- No stash create/apply/drop (including
--autostash) - No branch switching or worktree changes
- No stash create/apply/drop (including
- Scope your commits:
- "commit" = your changes only
- "commit all" = everything in grouped chunks
- "push" =
pull --rebaseOK to integrate others' work
- Ignore unrecognized files - focus on your changes, note "other files present" only if relevant
- All AGENTS.md files must include version:
<!-- Version: X.Y.Z | Last updated: YYYY-MM-DD -->
Informational only. Can be ignored during normal work.