Skip to content

Commit f19ead8

Browse files
committed
Reformatting contribution rules
1 parent a97b808 commit f19ead8

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -46,15 +46,15 @@ We are open to all contributions by members of our organization, and we encourag
4646

4747
* Issues should have useful, concise titles and enough of a description to understand the scope of the issue.
4848

49-
2. Branches should link to individual issues, and be named using consistent syntax:
49+
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:
5050

51-
* > bug/#123-abbreviated-issue-title
52-
> feature/#123-abbreviated-issue-title
53-
> enhancement/#123-abbreviated-issue-title
51+
* bug/#123-abbreviated-issue-title
52+
* feature/#123-abbreviated-issue-title
53+
* enhancement/#123-abbreviated-issue-title
5454

5555
3. A branch should represent an atomic change
5656

57-
> 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.
57+
* 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.
5858

5959
4. All pull requests should merge to development. Only an admin should merge to master.
6060

@@ -64,7 +64,7 @@ We are open to all contributions by members of our organization, and we encourag
6464

6565
7. Pull Requests should use Github keywords so they automatically link to/close related issues.
6666

67-
> For reference: https://help.github.com/articles/closing-issues-via-commit-messages/
67+
* For reference: https://help.github.com/articles/closing-issues-via-commit-messages/
6868

6969
For more info on good github etiquette see below, these were nicely referenced by @karimamer :
7070

0 commit comments

Comments
 (0)