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