We'd love to accept your patches and contributions to this project!!
To get started developing, see our DEVELOPMENT.md.
In this file you'll find info on:
- The CLA
- The code review process
- Standards around commit messages and code
- Finding something to work on
Contributions to this project must be accompanied by a Contributor License Agreement. You (or your employer) retain the copyright to your contribution; this simply gives us permission to use and redistribute your contributions as part of the project. Head over to https://cla.developers.google.com/ to see your current agreements on file or to sign a new one.
You generally only need to submit a CLA once, so if you've already submitted one (even if it was for a different project), you probably don't need to do it again.
All submissions, including submissions by project members, require review. We use GitHub pull requests for this purpose. Consult GitHub Help for more information on using pull requests.
This section describes the standards we will try to maintain in this repo.
All commit messages should follow these best practices, specifically:
- Start with a subject line
- Contain a body that explains why you're making the change you're making
- Reference an issue number if one exists, closing it if applicable (with text such as "Fixes #245" or "Closes #111")
Aim for 2 paragraphs in the body. Not sure what to put? Include:
- What is the problem being solved?
- Why is this the best approach?
- What other approaches did you consider?
- What side effects will this approach have?
- What future work remains to be done?
The code in this repo should follow best practices, specifically:
Thanks so much for considering contributing to our project!! We hope very much you can find something interesting to work on:
- To find issues that we particularly would like contributors to tackle, look for issues with the "help wanted" label.
- Issues that are good for new folks will additionally be marked with "good first issue".