diff options
| author | Paul Buetow <paul@buetow.org> | 2025-09-06 10:58:15 +0300 |
|---|---|---|
| committer | Paul Buetow <paul@buetow.org> | 2025-09-06 10:58:15 +0300 |
| commit | 04391bc5de2e965bfc61f81f66490b2b051f202d (patch) | |
| tree | f741253acaa4ff2ec33b813f5d50c0eb8eb20ed3 /AGENTS.md | |
| parent | 320de746f7a2985b60c8564a0e65bdf231e840b7 (diff) | |
update guidelines
Diffstat (limited to 'AGENTS.md')
| -rw-r--r-- | AGENTS.md | 7 |
1 files changed, 2 insertions, 5 deletions
@@ -3,17 +3,14 @@ ## Project Structure & Module Organization - `README.md`: Project overview and quick context. -- `assets/`: Optimized images and brand assets (place new images here). Existing - legacy files: `hexai.png`, `hexai-small.png`. -- `src/`: Future implementation code. -- `tests/`: Future test suites mirroring `src/` paths. +- `assets/`: Images and brand assets - `scripts/`: Helper tools and maintenance scripts. ## Coding Style & Naming Conventions - Aim for at least 85% unit test coverage of all source code. -- Always run the gofumpt code reformater on all go files modified. - 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. |