blob: dc131744280b9f237e23730ff35f5386ae9ebe6e (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
|
# Repository Guidelines
## Project Structure & Module Organization
- `README.md`: Project overview and quick context.
- `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.
- 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`).
- Code (when added): follow language idioms
|
