From ce1e9d05b64357ac288e6a2e7d742bee5b0d7ce9 Mon Sep 17 00:00:00 2001 From: anonimal Date: Sat, 15 Jul 2017 23:20:15 +0000 Subject: [PATCH] Docs: add General Guidelines to contributing guide --- CONTRIBUTING.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 42b81287..48dd2cae 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,3 +1,12 @@ +# General Guidelines + +- Commits should be [atomic](https://en.wikipedia.org/wiki/Atomic_commit#Atomic_commit_convention) and diffs should be easy to read. Please try to not mix formatting fixes with non-formatting commits +- The body of the pull request should: + * contain an accurate description of what the patch does + * provide justification/reasoning for the patch (when appropriate) + * include references to any discussions such as other tickets or chats on IRC +- If a particular commit references another issue, please add a reference. For example "See #123", or "Fixes #123". This will help us resolve tickets when we merge into `master` + # [Code of Conduct (22/C4.1)](http://rfc.zeromq.org/spec:22) ## License