update: add more instructions in AGENTS.md

2026-04-17 15:24:40 -04:00
parent 06eff1c255
commit 088e07dee8
1 changed files with 21 additions and 0 deletions
@@ -586,6 +586,27 @@ If a change affects on-disk formats or CLI behavior, document it clearly.
 ---
 ## Development workflow guidelines
 Follow these practices during development:
 1. Use `uv run` whenever a Python call is needed (e.g., `uv run python script.py`, `uv run pytest`)
 2. Establish testing library in `./.tmp` (which is a tmpfs) rather than in global `/tmp`
 3. Run `uv run ruff check src/` to check format and style after each development step
 4. Make git commits in format of `"<scope>: <subject>"`, where `<scope>` can only be one of:
   - "feat" (feature)
   - "fix"
   - "docs"
   - "style"
   - "refactor"
   - "test"
   - "perf" (performance)
   - "update" (for misc update)
   The first line of commit message should be within 88 characters, the second line should be empty, and the message body starting from the third line is optional and should be short and clean if present.
 ---
 ## Decision heuristics
 When uncertain, prefer the option that is: