Blame CONTRIBUTING.md

Packit Service 9def5d
# How to contribute #
Packit Service 9def5d
Packit Service 9def5d
We'd love to accept your patches and contributions to this project.  There are
Packit Service 9def5d
a just a few small guidelines you need to follow.
Packit Service 9def5d
Packit Service 9def5d
Packit Service 9def5d
## Contributor License Agreement ##
Packit Service 9def5d
Packit Service 9def5d
Contributions to any Google project must be accompanied by a Contributor
Packit Service 9def5d
License Agreement.  This is not a copyright **assignment**, it simply gives
Packit Service 9def5d
Google permission to use and redistribute your contributions as part of the
Packit Service 9def5d
project.
Packit Service 9def5d
Packit Service 9def5d
  * If you are an individual writing original source code and you're sure you
Packit Service 9def5d
    own the intellectual property, then you'll need to sign an [individual
Packit Service 9def5d
    CLA][].
Packit Service 9def5d
Packit Service 9def5d
  * If you work for a company that wants to allow you to contribute your work,
Packit Service 9def5d
    then you'll need to sign a [corporate CLA][].
Packit Service 9def5d
Packit Service 9def5d
You generally only need to submit a CLA once, so if you've already submitted
Packit Service 9def5d
one (even if it was for a different project), you probably don't need to do it
Packit Service 9def5d
again.
Packit Service 9def5d
Packit Service 9def5d
[individual CLA]: https://developers.google.com/open-source/cla/individual
Packit Service 9def5d
[corporate CLA]: https://developers.google.com/open-source/cla/corporate
Packit Service 9def5d
Packit Service 9def5d
Once your CLA is submitted (or if you already submitted one for
Packit Service 9def5d
another Google project), make a commit adding yourself to the
Packit Service 9def5d
[AUTHORS][] and [CONTRIBUTORS][] files. This commit can be part
Packit Service 9def5d
of your first [pull request][].
Packit Service 9def5d
Packit Service 9def5d
[AUTHORS]: AUTHORS
Packit Service 9def5d
[CONTRIBUTORS]: CONTRIBUTORS
Packit Service 9def5d
Packit Service 9def5d
Packit Service 9def5d
## Submitting a patch ##
Packit Service 9def5d
Packit Service 9def5d
  1. It's generally best to start by opening a new issue describing the bug or
Packit Service 9def5d
     feature you're intending to fix.  Even if you think it's relatively minor,
Packit Service 9def5d
     it's helpful to know what people are working on.  Mention in the initial
Packit Service 9def5d
     issue that you are planning to work on that bug or feature so that it can
Packit Service 9def5d
     be assigned to you.
Packit Service 9def5d
Packit Service 9def5d
  1. Follow the normal process of [forking][] the project, and setup a new
Packit Service 9def5d
     branch to work in.  It's important that each group of changes be done in
Packit Service 9def5d
     separate branches in order to ensure that a pull request only includes the
Packit Service 9def5d
     commits related to that bug or feature.
Packit Service 9def5d
Packit Service 9def5d
  1. Do your best to have [well-formed commit messages][] for each change.
Packit Service 9def5d
     This provides consistency throughout the project, and ensures that commit
Packit Service 9def5d
     messages are able to be formatted properly by various git tools.
Packit Service 9def5d
Packit Service 9def5d
  1. Finally, push the commits to your fork and submit a [pull request][].
Packit Service 9def5d
Packit Service 9def5d
[forking]: https://help.github.com/articles/fork-a-repo
Packit Service 9def5d
[well-formed commit messages]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
Packit Service 9def5d
[pull request]: https://help.github.com/articles/creating-a-pull-request