First off, thank you for contributing! We're excited to collaborate with you! 🎉
The following is a set of guidelines for the many ways you can join our collective effort.
Before anything else, please take a moment to read our Code of Conduct. We expect all participants, from full-timers to occasional tinkerers, to uphold it.
Have a suggestion or feedback? Please go to Issues and open a new issue. Prefix the title with a category like "Bug:", "Question:", or "Feature Request:". Logs help us resolve issues and answer questions faster, so thanks for including some if you can.
If you plan to work on an issue, coordinate with the team by commenting in the issue and discussing with maintainers before diving too deep on any sort of implementation. Committing a lot of effort only to have a PR rejected can be frustrating, so it's best to see if your ideas jive with the project for things you want to contribute back.
When submitting changes, we use black and isort to keep our code clean. Please run ./autoformat.sh in the project directory to cleanup code before submitting. Checks will be performed by automated tools and give you a success message if the changes are expected to past all lint checks.
Unless you are a maintainer, you should not upgrade lock files. This helps avoid any crazy merge conflicts. Maintainers can update the lock files just before pulling in your changes.
When opening a PR from a fork, some of the CI checks must be manually triggered by a member of the team. That means you don't need to worry if some of the CI checks are not running—we'll take care of it when we review the PR and, if there are any issues, we'll let you know.
- PRs require one reviewer to approve the PR before it can be merged to the base branch
- We keep the PR git history when merging (merge via "merge commit")
- The reviewer who approved the PR may merge it right after approval (without waiting for the PR author) if all checks are green.
- The reviewer may also suggest, make changes, or decline the PR for various reasons. Know that we really appreciate and value the input and contribution effort. Start a discussion in issue tickets, PRs, or under discussions to help plan your efforts effectively.