alexion/dev
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(agents): fold comment guidance into writing section

Browse Source
This commit is contained in:
alexion
2026-09-02 22:03:42 -04:00
parent 050f6599a9
commit 474ef9f424
1 changed files with 2 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
AGENTS.md
View File

@@ -14,6 +14,8 @@
- Use `docs/technical-writing.md` and `docs/dictionary.md` for authored prose, comments, and Markdown formatting. - Use `docs/technical-writing.md` and `docs/dictionary.md` for authored prose, comments, and Markdown formatting.
Use the nearest project dictionary for project-specific domain language. Use the nearest project dictionary for project-specific domain language.
- Write comments only where they earn their place.
Comments must explain purpose, preconditions, invariants, or non-obvious consequences.
## Pull requests ## Pull requests
@@ -59,12 +61,6 @@
Before ending a workflow turn, perform the obvious next step, such as showing the next review item after applying an accepted change. Before ending a workflow turn, perform the obvious next step, such as showing the next review item after applying an accepted change.
If the workflow is paused, say that plainly instead of using a dangling transition like "continuing" or "next". If the workflow is paused, say that plainly instead of using a dangling transition like "continuing" or "next".
## Comments
- Follow `docs/technical-writing.md` for comments and authored prose.
- Write comments only where they earn their place.
Comments must explain purpose, preconditions, invariants, or non-obvious consequences.
## Corrections ## Corrections
- When you discover that your belief about a project fact or convention was wrong, record the correction. - When you discover that your belief about a project fact or convention was wrong, record the correction.