Skip to content

Commit 63ad425

Browse files
committed
More reformatting of contribution rules
1 parent f19ead8 commit 63ad425

File tree

1 file changed

+3
-8
lines changed

1 file changed

+3
-8
lines changed

README.md

+3-8
Original file line numberDiff line numberDiff line change
@@ -43,17 +43,14 @@ We are open to all contributions by members of our organization, and we encourag
4343
**However, we do have some rules and general guidelines we would like you to follow:**
4444

4545
1. Everything must start with an issue...
46-
4746
* Issues should have useful, concise titles and enough of a description to understand the scope of the issue.
4847

4948
2. Branches should link to individual issues, and be named using consistent syntax consisting of "issue type", "issue number", and an descriptive title (using hyphens for spaces, and all lower case). Examples:
50-
5149
* bug/#123-abbreviated-issue-title
5250
* feature/#123-abbreviated-issue-title
5351
* enhancement/#123-abbreviated-issue-title
5452

5553
3. A branch should represent an atomic change
56-
5754
* Merging the branch should not break anything. A branch should be fully testable and functional once finished - I should be able to deploy any given branch and have a functional site.
5855

5956
4. All pull requests should merge to development. Only an admin should merge to master.
@@ -63,10 +60,8 @@ We are open to all contributions by members of our organization, and we encourag
6360
6. Once a pull request is merged, the branch should be removed.
6461

6562
7. Pull Requests should use Github keywords so they automatically link to/close related issues.
66-
6763
* For reference: https://help.github.com/articles/closing-issues-via-commit-messages/
6864

69-
For more info on good github etiquette see below, these were nicely referenced by @karimamer :
70-
71-
[Git - Contributing to a Project](http://git-scm.com/book/ch5-2.html)
72-
[Who-T - On Commit Messages](http://who-t.blogspot.com/2009/12/on-commit-messages.html)
65+
8. Always follow good Github etiquette. Several helpful reads on the topic:
66+
* [Git - Contributing to a Project](http://git-scm.com/book/ch5-2.html)
67+
* [Who-T - On Commit Messages](http://who-t.blogspot.com/2009/12/on-commit-messages.html)

0 commit comments

Comments
 (0)