Contributing

Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.

If you have any substantial changes that you would like to make, please open an issue to start a discussion.

Contributions to this project are released to the public under the project's open source license.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Submitting a pull request

1. Read through the docs in this folder for information on setup and our development practices
2. Fork and clone the repository
3. Create a new branch: git switch -n your-username/your-feature
4. Make your change, add tests, and make sure all the tests still pass
5. Add an entry to the top of CHANGELOG.md for your change under the appropriate heading
6. Push to your fork and submit a pull request
7. Pat yourself on the back and wait for your pull request to be reviewed and merged, after merging it will be included in the next release

PR tips

Here are a few things you can do that will increase the likelihood of your pull request being accepted:

• Write a descriptive pull request message
• Keep your change as focused as possible; if there are multiple changes you would like to make that are not dependent on one other consider submitting them as separate pull requests
• Write comprehensive documentation and make sure the generated documentation is committed
• Write thorough tests