Thanks for considering a contribution — issues and pull requests are welcome.
- Fork the repository and clone your fork.
- Install dependencies and run the project as described in the README.
- Create a branch for your change:
git checkout -b my-change.
- Keep pull requests focused and describe what changed and why.
- Run the project's format, lint, and test steps (see the README) before pushing.
- Add or update tests when you change behavior.
- Update docs or the CHANGELOG when relevant.
New here? Look for issues labeled good first issue
— they're small, scoped, and have enough context to start. Ask questions right
in the issue; I usually reply within a day.
Open an issue using the provided templates. Clear reproduction steps (for bugs) or a concrete use case (for ideas) help a lot.
By contributing, you agree that your contributions will be licensed under the same license as this project, and that you will follow the Code of Conduct.
Want to pick something up? Just comment on the issue saying you'd like to work on
it. A workflow adds the claimed label so nobody else duplicates your effort.
Two small rules keep things fair:
- Two open claims per person. If you already hold two claimed issues, we'll ask you to finish one first so other people get a turn. Comment again once one lands and the next is yours.
- Claims go stale after 14 days. If a claimed issue sees no activity for two weeks, the label is removed and it goes back in the pool. No hard feelings, and you can always claim it again.
Link your pull request to the issue in the PR description (for example
Closes #12). When that PR is merged the issue closes itself, and if the PR is
closed without being merged the claim is released so someone else can pick it up.
No pressure on timelines otherwise. Ask questions in the issue thread any time.