Skip to content

Commit

Permalink
Add contributing file
Browse files Browse the repository at this point in the history
  • Loading branch information
aphyr committed Apr 4, 2019
1 parent dd5c297 commit d7f501a
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions contributing.md
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!

0 comments on commit d7f501a

Please sign in to comment.