You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+3-8
Original file line number
Diff line number
Diff line change
@@ -43,17 +43,14 @@ We are open to all contributions by members of our organization, and we encourag
43
43
**However, we do have some rules and general guidelines we would like you to follow:**
44
44
45
45
1. Everything must start with an issue...
46
-
47
46
* Issues should have useful, concise titles and enough of a description to understand the scope of the issue.
48
47
49
48
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
-
51
49
* bug/#123-abbreviated-issue-title
52
50
* feature/#123-abbreviated-issue-title
53
51
* enhancement/#123-abbreviated-issue-title
54
52
55
53
3. A branch should represent an atomic change
56
-
57
54
* 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.
58
55
59
56
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
63
60
6. Once a pull request is merged, the branch should be removed.
64
61
65
62
7. Pull Requests should use Github keywords so they automatically link to/close related issues.
66
-
67
63
* For reference: https://help.github.com/articles/closing-issues-via-commit-messages/
68
64
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