Contributing
Bug reports, ideas and pull requests are welcome.
Issues
Describe what you ran, what you expected and what happened instead. Real
but rare problems are labeled
edge case:
they are handled later, not in the pull request that found them.
Pull requests
- Set up the development environment.
- Change behaviour together with a test whose name states it. If the
output changes,
just docs-check --writeupdates the scenarios and walkthroughs, and the diff shows readers what changed. - Run
just ci: lint, formatting, tests, docs-check and the site build. - Open the pull request as a draft. Expensive checks such as the benchmark run only once it is marked ready for review.
Pull requests are squash-merged, so the title becomes the commit message
on main. It must follow
Conventional Commits, e.g.
fix(push): ..., since release-please builds the changelog from it. The
description should say why the change is needed.