To get an overview of the project, read the README. Here are some resources to help you get started with open source contributions:
- Finding ways to contribute to open source on GitHub
- Set up Git
- GitHub flow
- Collaborating with pull requests
- Clone the repository or Create new branch from develop
- Navigate to the project root directory
- Setup pre-commit hook
- poetry install - Installs all dependencies, including pre-commit
- poetry run pre-commit install - Installs pre-commit hooks
- Write code
- Write tests
- Create a PR
- Code review
If you spot a problem with the docs, search if an issue already exists. If a related issue doesn't exist, you can open a new issue using a relevant issue form.