You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: AGENTS.md
+3-1Lines changed: 3 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -73,7 +73,8 @@ Uses **Git Flow** (see `docs/gitflow.md`).
73
73
74
74
## Pull Requests
75
75
76
-
-**Do NOT add a "Test plan" / "Testing" checklist to PR bodies.** CI runs the full test suite on every PR — a hand-rolled checklist duplicates that signal and rots fast. Use the PR body for _Summary_ and _Root cause_ (if relevant) only.
76
+
-**Do NOT add a "Test plan" / "Testing" checklist to PR bodies.** CI runs the full test suite on every PR — a hand-rolled checklist duplicates that signal and rots fast. Write the summary content directly and add a _Root cause_ section only if relevant.
77
+
-**Omit the "Summary" heading** in PR bodies — lead with the summary text itself, no `## Summary` header.
77
78
- Include `Fixes #<issue-number>` somewhere in the PR body so the merge auto-closes the linked issue.
78
79
79
80
## Architecture
@@ -130,6 +131,7 @@ Uses **Git Flow** (see `docs/gitflow.md`).
130
131
- Only use libraries already in the codebase
131
132
- Never expose secrets or keys
132
133
- When modifying files, cover all occurrences (including `src/` and `test/`)
134
+
- Comments explain **why**, never **what** — never add a comment that restates what the code does or describes the change being made; only comment when the reasoning isn't obvious from the code itself
0 commit comments