-
Notifications
You must be signed in to change notification settings - Fork 726
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
21 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
# Contributing to Jepsen | ||
|
||
Hi there, and thanks for helping make Jepsen better! I've got just one request: | ||
start your commit messages with the *part* of Jepsen you're changing. For | ||
instance, if I made a change to the MongoDB causal consistency tests: | ||
|
||
> MongoDB causal: fix a bug when analyzing zero-length histories | ||
Namespaces are cool too! | ||
|
||
> jepsen.os.debian: fix libzip package name for debian stretch | ||
If you're making a chance to the core Jepsen library, as opposed to a specific | ||
database test, you can be more concise: | ||
|
||
> add test for single nemesis events | ||
Jepsen's a big project with lots of moving parts, and it can be confusing to | ||
read the commit logs. Giving a bit of context makes my life a lot easier. | ||
|
||
Thanks! |