commit cf5d8d40915f6242c4b96e0bb6a7847c8a243ebc
parent dc36b0c1b67508382bc118ca826b365311c7b42e
Author: wmorgan <wmorgan@5c8cc53c-5e98-4d25-b20a-d8db53a31250>
Date: Wed, 17 Jan 2007 21:24:47 +0000
added coding style guidelines
git-svn-id: svn://rubyforge.org/var/svn/sup/trunk@256 5c8cc53c-5e98-4d25-b20a-d8db53a31250
Diffstat:
1 file changed, 16 insertions(+), 1 deletion(-)
diff --git 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.)
+