summaryrefslogtreecommitdiff
path: root/AGENTS.md
diff options
context:
space:
mode:
authorPaul Buetow <paul@buetow.org>2025-08-16 14:58:03 +0300
committerPaul Buetow <paul@buetow.org>2025-08-16 14:58:03 +0300
commit1e1df8c204f6771719f85d8402128d72138bb863 (patch)
tree20508d35f86625ff5b74b509176111ffde163605 /AGENTS.md
parenta6a8b84690c50767f714b413496b5aeb45b31c21 (diff)
llm: add pluggable provider with OpenAI default; extensive logging; LSP completion integration with TextEdit, param-aware prompts; remove idle gating; label/filter improvements; docs update
Diffstat (limited to 'AGENTS.md')
-rw-r--r--AGENTS.md44
1 files changed, 19 insertions, 25 deletions
diff --git a/AGENTS.md b/AGENTS.md
index b93bef8..e7c6d2b 100644
--- a/AGENTS.md
+++ b/AGENTS.md
@@ -1,36 +1,30 @@
# Repository Guidelines
-This repository currently holds documentation and brand assets for HexAI. It is intentionally lightweight; additional modules and code may be added over time. The guidance below keeps contributions consistent and easy to review.
-
## Project Structure & Module Organization
+
- `README.md`: Project overview and quick context.
- `IDEAS.md`: Working notes, concepts, and rough drafts.
-- Images: `hexai.png`, `hexai-small.png` (place new images under `assets/` going forward, referenced with relative paths).
-- Future code (if added): `src/` for implementation, `tests/` for test suites, `scripts/` for helper tools.
+- `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.
+- `scripts/`: Helper tools and maintenance scripts.
## 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`.
- No build step required for docs-only changes.
-- Preview Markdown: use your editor’s preview or `glow README.md`.
-- Optional checks (if installed locally):
- - `markdownlint **/*.md`: Lint Markdown formatting.
- - `codespell`: Catch common typos.
-- Optimize images before committing, e.g.: `pngquant --quality=70-85 input.png -o assets/input.png`.
## Coding Style & Naming Conventions
-- Markdown: ATX `#` headings, sentence-case titles, wrap lines near ~100 chars, use fenced code blocks and descriptive link text.
-- Filenames: lowercase-with-dashes for docs (e.g., `design-notes.md`); images: kebab-case with size or purpose suffix (e.g., `hexai-small.png`).
-- If/when code is added: follow language idioms, 2 spaces or 4 spaces consistently per language, avoid one-letter identifiers, and keep functions short and focused.
-
-## Testing Guidelines
-- For now: validate links render and assets load; run a Markdown linter locally if available.
-- When tests exist: place unit tests in `tests/` mirroring module paths; name tests `test_<module_or_feature>.ext`; target high-value paths first.
-
-## Commit & Pull Request Guidelines
-- History is currently informal; adopt Conventional Commits (e.g., `feat:`, `fix:`, `docs:`) going forward.
-- Commits: small, scoped, and imperative subject line (≤72 chars).
-- PRs: clear description, link related issues, include before/after screenshots for visual or asset changes, and note any follow-ups.
-
-## Security & Asset Tips
-- Do not commit secrets or credentials.
-- Keep binary assets lean (<5 MB preferred); compress images and remove unused files.
+- 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; use consistent 2 or 4‑space
+ indentation; avoid one‑letter identifiers; keep functions short and focused.