From 088e07dee8d74eb5f8af3f7cdb30b21c705ca5bc Mon Sep 17 00:00:00 2001 From: Yingjie Wang Date: Fri, 17 Apr 2026 15:24:40 -0400 Subject: [PATCH] update: add more instructions in AGENTS.md --- AGENTS.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/AGENTS.md b/AGENTS.md index 2e88f74..1832362 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -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 `": "`, where `` 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: