Skip to content

Commit fce2300

Browse files
committed
docs(AGENTS): document test/lint/type-check flows and changelog discipline (Unreleased at top, succinct entries)
1 parent 8a340b8 commit fce2300

1 file changed

Lines changed: 19 additions & 2 deletions

File tree

AGENTS.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,23 @@
1010
- Create env: `python -m venv .venv && source .venv/bin/activate`.
1111
- Install dev deps: `pip install -e .[dev]`.
1212
- Run all tests + coverage: `tox`.
13-
- Style/lint (ruff): `tox -e style` (runs `ruff check --fix` and `ruff format`).
1413
- Extra tests with SQLean: `tox -e sqlean` (installs `[sqlean]` extras).
15-
- Run tests directly: `pytest -v` or focused: `pytest -k keyword`.
14+
- Run tests directly: `pytest -q` or focused: `pytest -k keyword`.
1615
- Launch CLI locally: `litecli path/to.db`.
1716

17+
### Ruff (lint/format)
18+
- Full style pass: `tox -e style` (runs `ruff check --fix` and `ruff format`).
19+
- Direct commands:
20+
- Lint: `ruff check` (add `--fix` to auto-fix)
21+
- Format: `ruff format`
22+
23+
### Mypy (type checking)
24+
- Repo-wide (recommended): `mypy --explicit-package-bases .`
25+
- Per-package: `mypy --explicit-package-bases litecli`
26+
- Notes:
27+
- Config is in `pyproject.toml` (target Python 3.9, stricter settings).
28+
- Use `--explicit-package-bases` to avoid module discovery issues when running outside tox.
29+
1830
## Coding Style & Naming Conventions
1931
- Formatter/linter: Ruff (configured via `.pre-commit-config.yaml` and `tox`).
2032
- Indentation: 4 spaces. Line length: 140 (see `pyproject.toml`).
@@ -33,6 +45,11 @@
3345
- PRs: include clear description, steps to reproduce/verify, and screenshots or snippets for CLI output when helpful. Use the PR template.
3446
- Ensure CI passes (tests + ruff). Re-run `tox -e style` before requesting review.
3547

48+
## Changelog Discipline
49+
- Always add an "Unreleased" section at the top of `CHANGELOG.md` when making changes.
50+
- Keep entries succinct; avoid overly detailed technical notes.
51+
- Group under "Features", "Bug Fixes", and "Internal" when applicable.
52+
3653
## Security & Configuration Tips
3754
- Do not commit local databases or secrets. Use files under `tests/data/` for fixtures.
3855
- User settings live outside the repo; document defaults by editing `litecli/liteclirc`.

0 commit comments

Comments
 (0)