From: Azat Khuzhin <a3at.mail@gmail.com>
Date: Mon, 15 Feb 2016 20:43:10 +0000 (+0300)
Subject: Add CONTRIBUTING.md (with checkpatch.sh examples)
X-Git-Tag: release-2.1.7-rc~22^2
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=a22d2033861284c0f25096b00bed8552a1ce2ed4;p=libevent

Add CONTRIBUTING.md (with checkpatch.sh examples)
---

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 00000000..38756939
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,35 @@
+# Contributing to the libevent
+
+## Coding style
+
+First and most generic rule: **just look around**.
+
+But, we have a script for checking patches/files/git-refs:
+```shell
+# Chech HEAD git ref
+./checkpatch.sh -r
+./checkpatch.sh -r HEAD
+
+# Check patch
+git format-patch --stdout -1 | ./checkpatch.sh -p
+git show -1 | ./checkpatch.sh -p
+
+# Or via regular files
+git format-patch --stdout -2
+./checkpatch.sh *.patch
+
+# Over a file
+./checkpatch.sh -d event.c
+./checkpatch.sh -d < event.c
+
+# And print the whole file not only summary
+./checkpatch.sh -f event.c
+./checkpatch.sh -f < event.c
+
+# See
+./checkpatch.sh -h
+```
+
+## Testing
+- Write new unit test in `test/regress_{MORE_SUITABLE_FOR_YOU}.c`
+- `make verify`