1  # CONTRIBUTING
 2  
 3  Contributions are very welcome. When contributing code, please follow these
 4  simple guidelines.
 5  
 6  * Make sure you run `rustfmt` on your code. Also ensure all trailing whitespace
 7  is trimmed.
 8  * Run the tests with `cargo test --all`.
 9  * Don't add any new dependencies.
10  * Write properly formatted git commits (see below).
11  
12  Git commits
13  -----------
14  A properly formed git commit subject line should always be able to complete the
15  following sentence:
16  
17       If applied, this commit will _____
18  
19  For example, the following message is well formed:
20  
21       Add support for .gif files
22  
23  In addition, it should be capitalized and *must not* include a period.
24  
25  When it comes to formatting, here's a model git commit message[1]:
26  
27       Capitalized, short (50 chars or less) summary
28  
29       More detailed explanatory text, if necessary.  Wrap it to about 72
30       characters or so.  In some contexts, the first line is treated as the
31       subject of an email and the rest of the text as the body.  The blank
32       line separating the summary from the body is critical (unless you omit
33       the body entirely); tools like rebase can get confused if you run the
34       two together.
35  
36       Write your commit message in the imperative: "Fix bug" and not "Fixed bug"
37       or "Fixes bug."  This convention matches up with commit messages generated
38       by commands like git merge and git revert.
39  
40       Further paragraphs come after blank lines.
41  
42       - Bullet points are okay, too.
43  
44       - Typically a hyphen or asterisk is used for the bullet, followed by a
45         single space, with blank lines in between, but conventions vary here.
46  
47       - Use a hanging indent.
48  
49  ---
50  
51  [1]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html