aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMarc Schink <jaylink-dev@marcschink.de>2016-10-29 11:56:52 +0200
committerMarc Schink <jaylink-dev@marcschink.de>2016-11-05 14:39:48 +0100
commita43f81180f58807e5d368771c1095e8947ca86f1 (patch)
treeed18a54380188a6ed2b0b31c17ebe3e777442bf2
parentabadf66b5664980e327423f9ce0a7c74318edce2 (diff)
Add initial HACKING file
Signed-off-by: Marc Schink <jaylink-dev@marcschink.de>
-rw-r--r--HACKING68
1 files changed, 68 insertions, 0 deletions
diff --git a/HACKING b/HACKING
new file mode 100644
index 0000000..a654e2a
--- /dev/null
+++ b/HACKING
@@ -0,0 +1,68 @@
+Hacking
+=======
+
+This document describes how to start hacking on the libjaylink project.
+Make sure you read through the README file before continuing.
+
+
+Coding style
+------------
+
+This project uses the Linux kernel coding style where appropiate, see
+<https://www.kernel.org/doc/Documentation/CodingStyle> for details.
+
+Amendments to the Linux kernel coding style:
+
+ - Do not use goto statements.
+ - Always declare variables at the beginng of a function.
+ - Do not assign values to variables at declaration time.
+
+
+Contributions
+-------------
+
+The following ways can be used to submit a contribution to the libjaylink
+project:
+
+ - Send patches generated with `git format-patch`.
+ - Push your changes to a public Git repository and send the URL where to pull
+ them from.
+
+In any case, send directly to <jaylink-dev@marcschink.de>.
+Before submitting, please consider the following:
+
+ - Every single patch must be compilable.
+ - Your contribution must work on all operating systems supported by
+ libjaylink.
+ - Develop your contribution against the current Git master branch.
+ - Check your contribution for memory leaks and similar errors by using
+ *valgrind*.
+
+
+Bug reports
+-----------
+
+Send bug reports directly to <jaylink-dev@marcschink.de>.
+Please try to include all of the following information in your report:
+
+ - Instructions to reproduce the bug (e.g., command-line invocations)
+ - Debug log output of libjaylink
+ - Information about your environment:
+ - Version of libjaylink
+ - Debug hardware, including hardware and firmware version (e.g.,
+ J-Link Ultra V4 compiled Sep 4 2015 18:12:49)
+ - Operating system (e.g., Debian GNU/Linux 8.4)
+ - Backtraces if the application using libjaylink is crashing.
+
+If the bug report is for a regression, additionally include the information
+above about the working version where appropiate.
+
+Please develop and attach a patch that solves the reported bug, if possible.
+See the guidelines for contributions above.
+
+
+Random notes
+------------
+
+ - Always use `log_err()`, `log_warn()`, `log_info()` and `log_dbg()` to output
+ messages. Never use `printf()` or similar functions directly.