HACKING

   1 = Rainbows! Hacker's Guide
   2
   3 === Tests
   4
   5 All tests are written in POSIX shell.  See README file in the t/ directory.
   6
   7 === Documentation
   8
   9 We use RDoc 3.9.x with Darkfish for documentation as much as possible,
  10 if you're on Ruby 1.8 you want to install the latest "rdoc" gem.  Due to
  11 the lack of RDoc-to-manpage converters we know about, we're writing
  12 manpages in Markdown and converting to troff/HTML with Pandoc.
  13
  14 Please wrap documentation at 72 characters-per-line or less (long URLs
  15 are exempt) so it is comfortably readable from terminals.
  16
  17 When referencing mailing list posts, use
  18 "http://bogomips.org/rainbows-public/m/$MESSAGE_ID" if possible since
  19 the Message-ID remains searchable even if the website becomes unavailable.
  20
  21 == Contributing
  22
  23 Contributions are welcome in the form of patches, pull requests, code
  24 review, testing, documentation, user support or any other feedback is
  25 welcome.  The mailing list is the central coordination point for all
  26 user and developer feedback and bug reports.
  27
  28 === Submitting Patches
  29
  30 Follow conventions already established in the code and do not exceed 80
  31 characters per line.
  32
  33 Inline patches (from "git format-patch -M") to the mailing list are
  34 preferred because they allow code review and comments in the reply to
  35 the patch.
  36
  37 We will adhere to mostly the same conventions for patch submissions as
  38 git itself.  See the Documentation/SubmittingPatches document
  39 distributed with git on on patch submission guidelines to follow.  Just
  40 don't email the git mailing list or maintainer with Rainbows! patches :)
  41
  42 No subscription is required to post to the mailing list at
  43 rainbows-public@bogomips.org
  44
  45 Please Cc: everyone on replies, as not everyone is subscribed.
  46
  47 == Building a Gem
  48
  49 In order to build the gem, you must install the following components:
  50
  51  * wrongdoc
  52  * pandoc
  53
  54 You can build the Unicorn gem with the following command:
  55
  56   gmake gem
  57
  58 == Running Development Versions
  59
  60 It is easy to install the contents of your git working directory:
  61
  62 Via RubyGems (recommended):
  63
  64   gmake install-gem
  65
  66 Without RubyGems (via setup.rb):
  67
  68   ruby setup.rb
  69
  70 It is not at all recommended to mix a RubyGems installation with an
  71 installation done without RubyGems, however.