HACKING

   1 Hacking
   2 =======
   3
   4 This document describes how to start hacking on the swodec project.
   5 Make sure you read through the README file before continuing.
   6
   7
   8 Coding style
   9 ------------
  10
  11 This project uses the Linux kernel coding style where appropiate, see
  12 <https://www.kernel.org/doc/html/latest/process/coding-style.html> for details.
  13
  14 Amendments to the Linux kernel coding style:
  15
  16  - Do not use goto statements.
  17  - Always declare variables at the beginng of a function.
  18  - Do not assign values to variables at declaration time.
  19
  20
  21 Contributions
  22 -------------
  23
  24 The following ways can be used to submit a contribution to the swodec project:
  25
  26  - Send patches generated with `git format-patch`.
  27  - Push your changes to a public Git repository and send the URL where to pull
  28    them from.
  29
  30 In any case, send directly to <dev@zapb.de>.
  31 Before submitting, please consider the following:
  32
  33  - Every single patch must be compilable.
  34  - Develop your contribution against the current Git master branch.
  35  - Check your contribution for memory leaks and similar errors by using
  36    *valgrind*.
  37
  38
  39 Bug reports
  40 -----------
  41
  42 Send bug reports directly to <dev@zapb.de>.
  43 Please try to include all of the following information in your report:
  44
  45  - Instructions to reproduce the bug (e.g., command-line invocations)
  46  - Trace data which causes the problem
  47  - Debug output of swodec and libswo
  48  - Information about your environment:
  49    - Version of swodec and libswo
  50    - Operating system (e.g., Debian GNU/Linux 8.4)
  51  - Backtraces if swodec is crashing.
  52
  53 If the bug report is for a regression, additionally include the information
  54 above about the working version where appropiate.
  55
  56 Please develop and attach a patch that solves the reported bug, if possible.
  57 See the guidelines for contributions above.