🚀 Contributing
Getting started
-
Ensure you have the
Hatch
installed (with pipx for example): -
Clone the repo
- Install dependencies and start coding
- Run tests
# Quality checks without modifying the code
hatch run quality:check
# Quality checks and auto-formatting
hatch run quality:format
# Run tests with coverage
hatch run tests:run
Working workflow
- Create an issue for the feature or bug you want to work on.
- Create a branch using the left panel on GitHub.
git fetch
andgit checkout
the branch.- Make changes and commit.
- Push the branch to GitHub.
- Create a pull request and ask for review.
- Merge the pull request when it's approved and CI passes.
- Delete the branch.
- Update your local repo with
git fetch
andgit pull
.
Last update:
2023-10-12
Created: 2023-10-12
Created: 2023-10-12