diff options
Diffstat (limited to 'AGENTS.md')
| -rw-r--r-- | AGENTS.md | 8 |
1 files changed, 3 insertions, 5 deletions
@@ -8,14 +8,12 @@ ## Coding Style & Naming Conventions +- If possible, construct individual methods so that they can be unit tested. But only if it doesn't add too much boilerplate to the code base. - Aim for at least 85% unit test coverage of all source code. - Ensure that all unit tests pass before merging any changes. - Always run the gofumpt code reformatter on all go files modified. -- If possible, construct individual methods so that they can be unit tested. But only if it doesn't add too much boilerplate to the code base. - There should be no source code file larger than 1000 lines. If so, split it up into multiple. - There should be no function larger then 50 lines. If so, refactor or split up into multiple smaller functions. -- Markdown: ATX `#` headings, sentence‑case titles, wrap lines ~100 chars, - use fenced code blocks and descriptive link text. -- Filenames: docs use `lowercase-with-dashes.md`; images use kebab‑case with - size/purpose suffix (e.g., `hexai-small.png`). +- Filenames: docs use `lowercase-with-dashes.md`; images use kebab‑case with size/purpose suffix (e.g., `hexai-small.png`). - Code (when added): follow language idioms +- Any type with more than 3 methods should be in it's own source code file, whereas the filename contains the name of the type. |