]> granicus.if.org Git - libevent/commitdiff
Add CONTRIBUTING.md (with checkpatch.sh examples)
authorAzat Khuzhin <a3at.mail@gmail.com>
Mon, 15 Feb 2016 20:43:10 +0000 (23:43 +0300)
committerAzat Khuzhin <a3at.mail@gmail.com>
Wed, 5 Oct 2016 12:51:40 +0000 (15:51 +0300)
CONTRIBUTING.md [new file with mode: 0644]

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644 (file)
index 0000000..3875693
--- /dev/null
@@ -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`