summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--HACKING57
-rw-r--r--Makefile.am1
2 files changed, 58 insertions, 0 deletions
diff --git a/HACKING b/HACKING
new file mode 100644
index 0000000..cb7d5f0
--- /dev/null
+++ b/HACKING
@@ -0,0 +1,57 @@
+Hacking
+=======
+
+This document describes how to start hacking on the swodec 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/html/latest/process/coding-style.html> 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 swodec 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 <swo-dev@marcschink.de>.
+Before submitting, please consider the following:
+
+ - Every single patch must be compilable.
+ - 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 <swo-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)
+ - Trace data which causes the problem
+ - Debug output of swodec and libswo
+ - Information about your environment:
+ - Version of swodec and libswo
+ - Operating system (e.g., Debian GNU/Linux 8.4)
+ - Backtraces if swodec 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.
diff --git a/Makefile.am b/Makefile.am
index 950529e..4ddbad2 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -20,4 +20,5 @@
ACLOCAL_AMFLAGS = -I m4
SUBDIRS = src
+EXTRA_DIST = HACKING
dist_man_MANS = man/swodec.1