We're thrilled to welcome contributions from the community. We recognize great projects are built through collaboration, and we’re excited to see what we can achieve together. Whether you're here to report a bug, suggest a new feature, make a correction, or add to our documentation, we're glad to have you on board.
Your contributions, ideas, and feedback are are essential to the growth and success of this project. We are eager to to get your input and support and invite anyone who wishes to join our efforts. All contributions are welcomed, large and small. But there are a few guidelines you need to follow and some details you should to be aware of.
Please note that contributions to our public projects are released to the public under the project's open source license.
All contributors and community interactions are held to a Contributor Code of Conduct. Some projects may adopt a project-specific code of conduct. By participating in this project you agree to abide by its terms.
All submissions by contributors and project members require review. Pull requests are used for this purpose. Please see GitHub Help for more information.
- Fork and clone the repository
- Configure and install the dependencies:
script/bootstrap - Make sure the tests pass on your machine:
script/cibuild - Create a new branch:
git checkout -b my-branch-name - Make your change, add tests, and make sure the tests still pass
- Push to your fork and submit a pull request
- Pat your self on the back and wait for your pull request to be reviewed and merged.
Here are a few things you can do that will increase the likelihood of your pull request being accepted:
- Follow standards for style, consistency, and code quality.
- Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, submit them as separate pull requests.
- Write good commit messages.