medlogic
/
olivetin
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

chore: Stop AI agents adding superflous comments

This commit is contained in:
jamesread 2025-10-24 21:31:54 +01:00
parent 439e952a25
commit fa94357374
1 changed files with 1 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
AGENTS.md
View File

@ -35,6 +35,7 @@ If you are looking for OliveTin's AI policy, you can find it in `AI.md`.
- Footer visibility is controlled by `showFooter` from Init API; tests may assert the footer is absent when config disables it. - Footer visibility is controlled by `showFooter` from Init API; tests may assert the footer is absent when config disables it.
### Coding Standards (Go) ### Coding Standards (Go)
- Avoid adding superflous comments that explain what the code is doing. Comments are only to describe business logic decisions.
- Prefer clear, descriptive names; avoid 1–2 letter identifiers. - Prefer clear, descriptive names; avoid 1–2 letter identifiers.
- Use early returns and handle edge cases first. - Use early returns and handle edge cases first.
- Do not swallow errors; propagate or log meaningfully. - Do not swallow errors; propagate or log meaningfully.