Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
32 lines (23 loc) · 1.04 KB

CONTRIBUTING.md

File metadata and controls

32 lines (23 loc) · 1.04 KB
Raw

Contributing

Bug reports and pull requests are welcome.

Before a PR

uv sync                    # light install is enough for the test suite
uv run pytest
cd ui && npm ci && npm run check && npm run build

All three must pass; CI runs the same commands on Ubuntu, macOS, and Windows.

A few things the test suite enforces that are easy to trip over:

  • If you add or change an API endpoint, update the endpoint list in docs/development.md — tests/test_docs.py compares it against the real routes in both directions.
  • Paths mentioned in the README and docs must exist.
  • File I/O needs explicit encoding="utf-8" (Windows defaults to cp1252 and this repo is full of accented French).

Scope notes

The correction prompts in server/corrections.py and server/engines.py are deliberately tuned to the bundled 1890 French manual. Making them book-configurable would be a welcome contribution; silently generalizing them away would not.

Docs are written plainly: sentence-case headings, concrete numbers, no marketing. Match that.