Coding Standards » History » Version 1

Eric Davis, 2010-08-19 03:10
Basic coding standards

1 1 Eric Davis
h1. Coding Standards
2 1 Eric Davis
3 1 Eric Davis
h2. Ruby and Rails Code
4 1 Eric Davis
5 1 Eric Davis
TODO: until then, follow the basic Ruby and Rails standards.
6 1 Eric Davis
7 1 Eric Davis
h2. Javascript
8 1 Eric Davis
9 1 Eric Davis
TODO
10 1 Eric Davis
11 1 Eric Davis
h2. CSS
12 1 Eric Davis
13 1 Eric Davis
TODO
14 1 Eric Davis
15 1 Eric Davis
h2. Commits
16 1 Eric Davis
17 1 Eric Davis
Commits should be formatted as below.  If you are contributed via git, this will save the committer a bunch of time:
18 1 Eric Davis
19 1 Eric Davis
<pre>
20 1 Eric Davis
Short summary of your commit, 72 characters. #nnnn
21 1 Eric Davis
22 1 Eric Davis
(This is optional) Longer description of the change, including a 
23 1 Eric Davis
list of what changed if it's a major change. Limit each line to 72
24 1 Eric Davis
characters and use basic textile (* for lists). 
25 1 Eric Davis
26 1 Eric Davis
Contributed by Your Name
27 1 Eric Davis
</pre>