HACKING

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