doc: add HACKING document
authorEric Wong <normalperson@yhbt.net>
Tue, 26 Feb 2013 08:19:05 +0000 (26 08:19 +0000)
committerEric Wong <normalperson@yhbt.net>
Tue, 26 Feb 2013 08:19:05 +0000 (26 08:19 +0000)
Thanks to Alex Wolfe for noticing.

.document
HACKING [new file with mode: 0644]

index a29a5b3..e75b6a0 100644 (file)
--- a/.document
+++ b/.document
@@ -46,3 +46,4 @@ Summary
 Test_Suite
 Static_Files
 Sandbox
+HACKING
diff --git a/HACKING b/HACKING
new file mode 100644 (file)
index 0000000..a855eac
--- /dev/null
+++ b/HACKING
@@ -0,0 +1,72 @@
+= Rainbows! Hacker's Guide
+
+=== Tests
+
+All tests are written in POSIX shell.  See README file in the t/ directory.
+
+=== Documentation
+
+We use RDoc 3.9.x with Darkfish for documentation as much as possible,
+if you're on Ruby 1.8 you want to install the latest "rdoc" gem.  Due to
+the lack of RDoc-to-manpage converters we know about, we're writing
+manpages in Markdown and converting to troff/HTML with Pandoc.
+
+Please wrap documentation at 72 characters-per-line or less (long URLs
+are exempt) so it is comfortably readable from terminals.
+
+When referencing mailing list posts, use
+"http://mid.gmane.org/$MESSAGE_ID" if possible since the Message-ID
+remains searchable even if Gmane becomes unavailable.
+
+== Contributing
+
+Contributions are welcome in the form of patches, pull requests, code
+review, testing, documentation, user support or any other feedback is
+welcome.  The mailing list is the central coordination point for all
+user and developer feedback and bug reports.
+
+=== Submitting Patches
+
+Follow conventions already established in the code and do not exceed 80
+characters per line.
+
+Inline patches (from "git format-patch -M") to the mailing list are
+preferred because they allow code review and comments in the reply to
+the patch.
+
+We will adhere to mostly the same conventions for patch submissions as
+git itself.  See the Documentation/SubmittingPatches document
+distributed with git on on patch submission guidelines to follow.  Just
+don't email the git mailing list or maintainer with Rainbows! patches :)
+
+No subscription is required to post to the mailing list at
+rainbows-talk@rubyforge.org
+
+Please ask for Cc: if you are not subscribed (Cc:-by-default is uncommon
+on Ruby mailing lists)
+
+== Building a Gem
+
+In order to build the gem, you must install the following components:
+
+ * wrongdoc
+ * pandoc
+
+You can build the Unicorn gem with the following command:
+
+  gmake gem
+
+== Running Development Versions
+
+It is easy to install the contents of your git working directory:
+
+Via RubyGems (recommended):
+
+  gmake install-gem
+
+Without RubyGems (via setup.rb):
+
+  ruby setup.rb
+
+It is not at all recommended to mix a RubyGems installation with an
+installation done without RubyGems, however.