added coding style guidelines

git-svn-id: svn://rubyforge.org/var/svn/sup/trunk@256 5c8cc53c-5e98-4d25-b20a-d8db53a31250

diff --git a/HACKING b/HACKING
index 637d5dd23ce1678fc6d69d9d972ef25ac2cf3c6e..47c072d14ba1c3a447c000345210b32c4e9ed6b6 100644 (file)
--- a/HACKING
+++ b/HACKING
@@ -1,4 +1,19 @@
-To run sup locally, invoke it like this:
+Running Sup locally
+-------------------
+Invoke it like this:
 
 ruby -I lib -w bin/sup
 
+Coding standards
+----------------
+
+- Wrap code at 99999 characters. The days of 80-column displays are
+  long over. Wrap comments and other text at whatever Emacs meta-Q
+  does.
+- Use as few parentheses as possible.
+- Use {} for one-liner blocks and do/end for multi-line blocks.
+- For one-line functions, put a semicolon before "end", like this:
+    def bool_writer *args; attr_writer(*args); end
+  (I just started doing this for no real reason, and now I kinda like
+  it.)
+