HACKING

   1 netsniff-ng HACKING
   2 ===================
   3
   4 Some information about potential netsniff-ng hackers!
   5
   6 How to check out netsniff-ng?
   7 =============================
   8
   9 git clone git://github.com/danborkmann/netsniff-ng.git
  10
  11 Some ideas of useful contributions/projects
  12 ===========================================
  13
  14 The best way to propose your ideas is to outline them in a short mail to
  15 workgroup@netsniff-ng.org or to our public mailing list address
  16 netsniff-ng@googlegroups.com. We are looking forward for your proposals!
  17 Of course, keep in mind that you can mail smaller fixes immediately.
  18
  19 How to make code contributions
  20 ==============================
  21
  22 The best way to make a contribution to netsniff-ng is to send us your
  23 code in the form of a unified diff against the latest released version
  24 and, preferably, the version from Git.
  25 Your patch should then be sent to bugs@netsniff-ng.org .
  26
  27 To make a unified diff, please follow these instructions:
  28
  29 1. Remove temporary files:
  30     make clean
  31
  32 2. Rename your source tree:
  33     cd ..
  34     mv netsniff-ng-xxx netsniff-ng-xxx-snazzy-feature
  35
  36 3. Checkout the original netsniff-ng source alongside it:
  37     git clone git://github.com/danborkmann/netsniff-ng.git
  38
  39 4. Generate the diffs:
  40     diff -urNb netsniff-ng-xxx netsniff-ng-xxx-snazzy-feature > /tmp/cool.patch
  41
  42 5. Check the patch and remove any unnecessary patches from the file.
  43
  44 6. If you've added several features, it's best to send them as
  45    several independent patches if you can.
  46
  47 If you have just patched one or two files, then making patches is even
  48 easier. For each file, just do:
  49
  50   cp file.c file.c.orig
  51    [Make changes to file.c ...]
  52   diff -u file.c.orig file.c > /tmp/file.c.patch
  53
  54 and just send us the patch: /tmp/file.c.patch.
  55
  56 Code Style
  57 ==========
  58
  59 Before submitting your patch make sure to indent your code appropriate.
  60 See CODING.
  61
  62 Credits
  63 =======
  64
  65 The idea of the outline and some general parts for this HACKING file
  66 derives from GNet (http://www.gnetlibrary.org/). Generally, I followed
  67 the general structure of their HACKING file.