xref: /leveldb-1.20/CONTRIBUTING.md (revision 803d6920)
1*803d6920SChris Mumford# Contributing
2*803d6920SChris Mumford
3*803d6920SChris MumfordWe'd love to accept your code patches! However, before we can take them, we
4*803d6920SChris Mumfordhave to jump a couple of legal hurdles.
5*803d6920SChris Mumford
6*803d6920SChris Mumford## Contributor License Agreements
7*803d6920SChris Mumford
8*803d6920SChris MumfordPlease fill out either the individual or corporate Contributor License
9*803d6920SChris MumfordAgreement as appropriate.
10*803d6920SChris Mumford
11*803d6920SChris Mumford* If you are an individual writing original source code and you're sure you
12*803d6920SChris Mumfordown the intellectual property, then sign an [individual CLA](https://developers.google.com/open-source/cla/individual).
13*803d6920SChris Mumford* If you work for a company that wants to allow you to contribute your work,
14*803d6920SChris Mumfordthen sign a [corporate CLA](https://developers.google.com/open-source/cla/corporate).
15*803d6920SChris Mumford
16*803d6920SChris MumfordFollow either of the two links above to access the appropriate CLA and
17*803d6920SChris Mumfordinstructions for how to sign and return it.
18*803d6920SChris Mumford
19*803d6920SChris Mumford## Submitting a Patch
20*803d6920SChris Mumford
21*803d6920SChris Mumford1. Sign the contributors license agreement above.
22*803d6920SChris Mumford2. Decide which code you want to submit. A submission should be a set of changes
23*803d6920SChris Mumfordthat addresses one issue in the [issue tracker](https://github.com/google/leveldb/issues).
24*803d6920SChris MumfordPlease don't mix more than one logical change per submission, because it makes
25*803d6920SChris Mumfordthe history hard to follow. If you want to make a change
26*803d6920SChris Mumford(e.g. add a sample or feature) that doesn't have a corresponding issue in the
27*803d6920SChris Mumfordissue tracker, please create one.
28*803d6920SChris Mumford3. **Submitting**: When you are ready to submit, send us a Pull Request. Be
29*803d6920SChris Mumfordsure to include the issue number you fixed and the name you used to sign
30*803d6920SChris Mumfordthe CLA.
31*803d6920SChris Mumford
32*803d6920SChris Mumford## Writing Code ##
33*803d6920SChris Mumford
34*803d6920SChris MumfordIf your contribution contains code, please make sure that it follows
35*803d6920SChris Mumford[the style guide](http://google-styleguide.googlecode.com/svn/trunk/cppguide.xml).
36*803d6920SChris MumfordOtherwise we will have to ask you to make changes, and that's no fun for anyone.
37