Skip to content

Latest commit

 

History

History
74 lines (52 loc) · 3.11 KB

CONTRIBUTING.md

File metadata and controls

74 lines (52 loc) · 3.11 KB
Raw

How to contribute

We'd love to accept your patches and contributions to this project. There are a just a few small guidelines you need to follow.

Contributor License Agreement

Contributions to any Google project must be accompanied by a Contributor License Agreement. This is not a copyright assignment, it simply gives Google permission to use and redistribute your contributions as part of the project.

  • If you are an individual writing original source code and you're sure you own the intellectual property, then you'll need to sign an individual CLA.

  • If you work for a company that wants to allow you to contribute your work, then you'll need to sign a corporate CLA.

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.

Once your CLA is submitted (or if you already submitted one for another Google project), make a commit adding yourself to the AUTHORS and CONTRIBUTORS files. This commit can be part of your first pull request.

Submitting a patch

  1. It's generally best to start by opening a new issue describing the bug or feature you're intending to fix. Even if you think it's relatively minor, it's helpful to know what people are working on. Mention in the initial issue that you are planning to work on that bug or feature so that it can be assigned to you.

  2. Follow the normal process of forking the project, and setup a new branch to work in. It's important that each group of changes be done in separate branches in order to ensure that a pull request only includes the commits related to that bug or feature.

  3. Do your best to have well-formed commit messages with a good description for each change. This provides consistency throughout the project, and ensures that commit messages are able to be formatted properly by various git tools.

  4. Keep PRs small and focused on a single issue. Do not make unrelated changes in the same PR "because you're there"; this includes reformatting of code, whether automatically or manually.

  5. Finally, push the commits to your fork and submit a pull request.

Style

Contributions should follow the Google C++ Style Guide. Code may be formatted with git clang-format.