HACKING

   1 = Ruby TDB Hacker's Guide
   2
   3 === Code Compatibility
   4
   5 We target C Ruby 1.9.3+ and (time permitting) Rubinius and their respective C
   6 APIs.
   7
   8 All of our C code should be compatible with all reasonably modern Unices
   9 and should run on compilers supported by the versions of Ruby we target.
  10
  11 We will NEVER support non-Free platforms under any circumstances.
  12
  13 Our C code follows K&R indentation style (hard tabs, tabs are always 8
  14 characters wide) and NOT the indentation style of Matz Ruby.
  15
  16 == Contributing
  17
  18 Contributions are welcome in the form of patches, pull requests, code
  19 review, testing, documentation, user support or any other feedback.  The
  20 {Ruby TDB public inbox}[mailto:ruby-tdb-public@yhbt.net] is the
  21 coordination point for all user and developer feedback and bug reports.
  22
  23 === Submitting Patches
  24
  25 Follow conventions already established in the code and do not exceed 80
  26 characters per line.
  27
  28 Inline patches (from "git format-patch -M") to the mailing list are
  29 preferred because they allow code review and comments in the reply to
  30 the patch.
  31
  32 We will adhere to mostly the same conventions for patch submissions as
  33 git itself.  See the Documentation/SubmittingPatches document
  34 distributed with git on on patch submission guidelines to follow.  Just
  35 don't email the git mailing list or maintainer with Ruby TDB patches :)
  36
  37 === Mailing list rules
  38
  39 * Do not {top post}[http://catb.org/jargon/html/T/top-post.html] in replies
  40 * Quote only the relevant portions of the message you're replying to
  41 * Do not send HTML mail, they will be mercilessly deleted.
  42
  43 When referencing mailing list posts, use
  44 <tt>https://yhbt.net/ruby-tdb-public/<$MESSAGE_ID>/</tt> since the
  45 Message-ID remains searchable even if a particular site becomes unavailable.
  46
  47 == Running Development Versions
  48
  49 It is easy to install the contents of your git working directory:
  50
  51 Via RubyGems (RubyGems 1.3.5+ recommended for prerelease versions):
  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.