diff options
Diffstat (limited to 'AGENTS.md')
| -rw-r--r-- | AGENTS.md | 4 |
1 files changed, 2 insertions, 2 deletions
@@ -3,7 +3,6 @@ ## Project Structure & Module Organization - `README.md`: Project overview and quick context. -- `IDEAS.md`: Working notes, concepts, and rough drafts. - `assets/`: Optimized images and brand assets (place new images here). Existing legacy files: `hexai.png`, `hexai-small.png`. - `src/`: Future implementation code. @@ -12,7 +11,6 @@ ## Build, Test, and Development Commands -- Preview Markdown: `glow README.md` (or your editor’s preview). - Lint Markdown: `markdownlint **/*.md` — checks heading/style rules. - Spellcheck: `codespell` — catches common typos. - Optimize images: `pngquant --quality=70-85 input.png -o assets/input.png`. @@ -20,6 +18,8 @@ ## Coding Style & Naming Conventions +- Aim for at least 80% unit test coverage of all source code. +- Ensure that all unit tests pass before merging any changes. - 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. |