Skip to content

Commit 4753c9b

Browse files
committed
Added a contributors section to README.md
In preparation for accepting GitHub pull requests this new README section outlines the general criteria that the leveldb project owners will use when accepting external (and internal) project contributions. ------------- Created by MOE: https://github.com/google/moe MOE_MIGRATED_REVID=111349899
1 parent e2446d0 commit 4753c9b

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

README.md

+31
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,37 @@ Authors: Sanjay Ghemawat (sanjay@google.com) and Jeff Dean (jeff@google.com)
2222
* Only a single process (possibly multi-threaded) can access a particular database at a time.
2323
* There is no client-server support builtin to the library. An application that needs such support will have to wrap their own server around the library.
2424

25+
# Contributing to the leveldb Project
26+
The leveldb project welcomes contributions. leveldb's primary goal is to be
27+
a reliable and fast key/value store. Changes that are in line with the
28+
features/limitations outlined above, and meet the requirements below,
29+
will be considered.
30+
31+
Contribution requirements:
32+
33+
1. **POSIX only**. We _generally_ will only accept changes that are both
34+
compiled, and tested on a POSIX platform - usually Linux. Very small
35+
changes will sometimes be accepted, but consider that more of an
36+
exception than the rule.
37+
38+
2. **Stable API**. We strive very hard to maintain a stable API. Changes that
39+
require changes for projects using leveldb _might_ be rejected without
40+
sufficient benefit to the project.
41+
42+
3. **Tests**: All changes must be accompanied by a new (or changed) test, or
43+
a sufficient explanation as to why a new (or changed) test is not required.
44+
45+
## Submitting a Pull Request
46+
Before any pull request will be accepted the author must first sign a
47+
Contributor License Agreement (CLA) at https://cla.developers.google.com/.
48+
49+
In order to keep the commit timeline linear
50+
[squash](https://git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Squashing-Commits)
51+
your changes down to a single commit and [rebase](https://git-scm.com/docs/git-rebase)
52+
on google/leveldb/master. This keeps the commit timeline linear and more easily sync'ed
53+
with the internal repository at Google. More information at GitHub's
54+
[About Git rebase](https://help.github.com/articles/about-git-rebase/) page.
55+
2556
# Performance
2657

2758
Here is a performance report (with explanations) from the run of the

0 commit comments

Comments
 (0)