tqcq/leveldb
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Update contributing guidelines.

Browse Source 
* Align CONTRIBUTING.md with the google/new-project template.
* Explain the support story for the CMake config.

PiperOrigin-RevId: 421120645
This commit is contained in:
Victor Costan 2022-01-11 22:06:10 +00:00 committed by Victor Costan
parent 1b51a3a968
commit 479a1f4e9b
2 changed files with 28 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

49
CONTRIBUTING.md
View File

@ -1,36 +1,31 @@
# Contributing # How to Contribute
We'd love to accept your code patches! However, before we can take them, we We'd love to accept your patches and contributions to this project. There are
have to jump a couple of legal hurdles. just a few small guidelines you need to follow.
## Contributor License Agreements ## Contributor License Agreement
Please fill out either the individual or corporate Contributor License Contributions to this project must be accompanied by a Contributor License
Agreement as appropriate. 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.
* If you are an individual writing original source code and you're sure you You generally only need to submit a CLA once, so if you've already submitted one
own the intellectual property, then sign an [individual CLA](https://developers.google.com/open-source/cla/individual). (even if it was for a different project), you probably don't need to do it
* If you work for a company that wants to allow you to contribute your work, again.
then sign a [corporate CLA](https://developers.google.com/open-source/cla/corporate).
Follow either of the two links above to access the appropriate CLA and ## Code Reviews
instructions for how to sign and return it.
## Submitting a Patch All submissions, including submissions by project members, require review. We
use GitHub pull requests for this purpose. Consult
[GitHub Help](https://help.github.com/articles/about-pull-requests/) for more
information on using pull requests.
1. Sign the contributors license agreement above. See [the README](README.md#contributing-to-the-leveldb-project) for areas
2. Decide which code you want to submit. A submission should be a set of changes where we are likely to accept external contributions.
that addresses one issue in the [issue tracker](https://github.com/google/leveldb/issues).
Please don't mix more than one logical change per submission, because it makes
the history hard to follow. If you want to make a change
(e.g. add a sample or feature) that doesn't have a corresponding issue in the
issue tracker, please create one.
3. **Submitting**: When you are ready to submit, send us a Pull Request. Be
sure to include the issue number you fixed and the name you used to sign
the CLA.
## Writing Code ## ## Community Guidelines
If your contribution contains code, please make sure that it follows This project follows [Google's Open Source Community
[the style guide](https://google.github.io/styleguide/cppguide.html). Guidelines](https://opensource.google/conduct/).
Otherwise we will have to ask you to make changes, and that's no fun for anyone.

6
README.md
View File

@ -99,6 +99,12 @@ Contribution requirements:
clang-format -i --style=file <file> clang-format -i --style=file <file>
``` ```
We are unlikely to accept contributions to the build configuration files, such
as `CMakeLists.txt`. We are focused on maintaining a build configuration that
allows us to test that the project works in a few supported configurations
inside Google. We are not currently interested in supporting other requirements,
such as different operating systems, compilers, or build systems.
## Submitting a Pull Request ## Submitting a Pull Request
Before any pull request will be accepted the author must first sign a Before any pull request will be accepted the author must first sign a