|
| 1 | +Checklist (and a short version for the impatient) |
| 2 | +================================================= |
| 3 | + |
| 4 | + * Commits: |
| 5 | + |
| 6 | + - Make commits of logical units. |
| 7 | + |
| 8 | + - Check for unnecessary whitespace with "git diff --check" before |
| 9 | + committing. |
| 10 | + |
| 11 | + - Commit using Unix line endings (check the settings around "crlf" in |
| 12 | + git-config(1)). |
| 13 | + |
| 14 | + - Do not check in commented out code or unneeded files. |
| 15 | + |
| 16 | + - The first line of the commit message should be a short |
| 17 | + description (50 characters is the soft limit, excluding ticket |
| 18 | + number(s)), and should skip the full stop. |
| 19 | + |
| 20 | + - Associate the issue in the message. The first line should include |
| 21 | + the issue number in the form "(GH-#XXXX) Rest of message". |
| 22 | + |
| 23 | + - The body should provide a meaningful commit message, which: |
| 24 | + |
| 25 | + - uses the imperative, present tense: "change", not "changed" or |
| 26 | + "changes". |
| 27 | + |
| 28 | + - includes motivation for the change, and contrasts its |
| 29 | + implementation with the previous behavior. |
| 30 | + |
| 31 | + - Make sure that you have tests for the bug you are fixing, or |
| 32 | + feature you are adding. |
| 33 | + |
| 34 | + - Make sure the test suites passes after your commit: |
| 35 | + `bundle exec rspec spec/acceptance` More information on [testing](#Testing) below |
| 36 | + |
| 37 | + - When introducing a new feature, make sure it is properly |
| 38 | + documented in the README.md |
| 39 | + |
| 40 | + * Submission: |
| 41 | + |
| 42 | + * Pre-requisites: |
| 43 | + |
| 44 | + - Make sure you have a [GitHub account](https://github.com/join) |
| 45 | + |
| 46 | + * Preferred method: |
| 47 | + |
| 48 | + - Fork the repository on GitHub. |
| 49 | + |
| 50 | + - Push your changes to a topic branch in your fork of the |
| 51 | + repository. (the format GH-1234-short_description_of_change is |
| 52 | + usually preferred for this project). |
| 53 | + |
| 54 | + - Submit a pull request to the repository. |
0 commit comments