shishantbiswas/coder
1
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2026-06-02 20:48:20 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: require substantive, concise comments describing behaviour (#25674)

Browse Source 
*Disclaimer: implemented by a Coder Agent using Claude Opus 4.6*

Adds a clause under **Writing Comments and Avoiding Unnecessary
Changes** in `AGENTS.md` specifying that comments must be:

- **Substantive** and **concise**
- Describe the **behaviour** of the code
- NOT describe the reasoning the agent used to produce the change

Includes concrete anti-pattern examples (`// Added per PR feedback`, `//
Refactored for clarity`) to make the expectation clear.
This commit is contained in:
Danny Kopping
2026-05-26 11:20:52 +02:00
committed by GitHub
parent 32ed9f1f39
commit d8dc782da5
1 changed files with 5 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
AGENTS.md
+5
View File
@@ -164,6 +164,11 @@ See [Modern Go](.claude/docs/GO.md) for comment formatting and the rule to
avoid unrelated edits. Preserve existing comments that explain non-obvious
behavior unless the task directly requires changing them.
Comments MUST be **substantive** and **concise**. Describe the **behaviour**
of the code, not the reasoning the agent used to produce the change. Do not
leave comments like `// Added per PR feedback` or `// Refactored for
clarity`. Instead, explain what the code does and why the behaviour matters.
### No Emdash or Endash
Do not use emdash (U+2014), endash (U+2013), or ` -- ` as punctuation