starred/orca
1
0
Fork 0
mirror of https://github.com/stablyai/orca.git synced 2026-09-22 00:02:31 +00:00
Code Issues Packages Projects Releases Wiki Activity

Refactor code comments section in AGENTS.md

Browse Source 
Removed bullet points from the code comments section and streamlined the text.
This commit is contained in:
Neil
2026-04-12 23:23:08 -07:00
committed by GitHub
parent 4a526c0d7d
commit fead39f00d
1 changed files with 1 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files
AGENTS.md
+1 -9
View File
@@ -2,15 +2,7 @@
## Code Comments: Document the "Why"
When writing or modifying code driven by a design doc or non-obvious constraint, you **must** add a comment explaining **why** the code behaves the way it does. "What" is visible in the code; "why" is not. Target these categories:
- Safety constraints (suppressed actions, guarded entry points)
- Fallback/error-handling choices and their rationale
- Architectural boundaries (IPC separation, which surface owns a feature)
- Compatibility shims (fields that exist for downstream plumbing, not semantics)
- Intentional omissions (skipped data, unsupported edge cases)
If the design doc has a gotcha, the code must have a comment. A maintainer who hasn't read the doc should still understand why the code must not be changed casually.
When writing or modifying code driven by a design doc or non-obvious constraint, you **must** add a comment explaining **why** the code behaves the way it does.
## Worktree Safety