HACKING

   1 = kgio Hacker's Guide
   2
   3 === Documentation
   4
   5 Please wrap documentation at 72 characters-per-line or less (long URLs
   6 are exempt) so it is comfortably readable from terminals.
   7
   8 When referencing mailing list posts, use
   9 <tt>https://yhbt.net/kgio-public/$MESSAGE_ID/</tt> if possible
  10 Message-ID remains searchable even if the archive becomes unavailable.
  11
  12 === Code Compatibility
  13
  14 We target mainline Ruby 1.9.3 and later.
  15
  16 All of our C code should be compatible with all reasonably modern Unices
  17 and should run on compilers supported by the versions of Ruby we target.
  18
  19 We will NEVER support non-Free platforms under any circumstances.
  20
  21 Our C code follows Linux kernel coding style (hard tabs, tabs are always 8
  22 characters wide) and NOT the indentation style of Matz Ruby.
  23
  24 == Contributing
  25
  26 Contributions are welcome in the form of patches, pull requests
  27 (format email with "git request-pull"), code review, testing,
  28 documentation, user support or any other feedback.
  29 <mailto:kgio-public@yhbt.net> <https://yhbt.net/kgio-public/> is the
  30 current coordination point for all user and developer feedback and
  31 bug reports (domain is subject to change since ICANN cannot be trusted).
  32
  33 === Submitting Patches
  34
  35 Follow conventions already established in the code and do not exceed 80
  36 characters per line.
  37
  38 Inline patches (from "git format-patch -M") to the mailing list are
  39 preferred because they allow code review and comments in the reply to
  40 the patch.
  41
  42 We will adhere to mostly the same conventions for patch submissions as
  43 git itself.  See the Documentation/SubmittingPatches document
  44 distributed with git on on patch submission guidelines to follow.  Just
  45 don't email the git mailing list or maintainer with kgio patches :)
  46
  47 == Running Development Versions
  48
  49 It is easy to install the contents of your git working directory:
  50
  51 Via RubyGems:
  52
  53   gmake install-gem
  54
  55 Without RubyGems (via setup.rb):
  56
  57   gmake install
  58
  59 It is not at all recommended to mix a RubyGems installation with an
  60 installation done without RubyGems, however.
  61
  62 === Tests
  63
  64 We use GNU make to run tests in parallel for historical reasons.  Users
  65 of GNU-based systems (such as GNU/Linux) usually have GNU make installed
  66 as "make" instead of "gmake".
  67
  68 Running the entire test suite with 4 tests in parallel:
  69
  70   gmake -j4 test
  71
  72 Running just one unit test:
  73
  74   gmake test/test_poll.rb