Skip to content

Commit f983379

Browse files
committed
(doc) Fix markdown violations
1 parent 960a56f commit f983379

File tree

1 file changed

+42
-43
lines changed

1 file changed

+42
-43
lines changed

CONTRIBUTING.md

Lines changed: 42 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1,52 +1,51 @@
1-
Contributors
2-
============
1+
# Contributors
32

43
## Contributing Process
54

65
### Get Buyoff Or Find Open Community Issues/Features
76

8-
* Through GitHub, or through the [Chat Room](https://gitter.im/GitTools/GitReleaseManager) (preferred), you talk about a feature you would like to see (or a bug), and why it should be in GitReleaseManager.
9-
* If approved through the Chat Room, ensure the accompanying GitHub issue is created with information and a link back to the Chat Room discussion.
10-
* Once you get a nod you can start on the feature.
11-
* Alternatively, if a feature is on the issues list with the [community tag](https://github.com/GitTools/GitReleaseManager/labels/Community), it is open for a patch. You should comment that you are signing up for it on the issue so someone else doesn't also sign up for the work.
7+
* Through GitHub, or through the [Chat Room](https://gitter.im/GitTools/GitReleaseManager) (preferred), you talk about a feature you would like to see (or a bug), and why it should be in GitReleaseManager.
8+
* If approved through the Chat Room, ensure the accompanying GitHub issue is created with information and a link back to the Chat Room discussion.
9+
* Once you get a nod you can start on the feature.
10+
* Alternatively, if a feature is on the issues list with the [community tag](https://github.com/GitTools/GitReleaseManager/labels/Community), it is open for a patch. You should comment that you are signing up for it on the issue so someone else doesn't also sign up for the work.
1211

1312
### Set Up Your Environment
1413

15-
* You create, or update, a fork of GitTools/GitReleaseManager under your GitHub account.
16-
* From there you create a branch named specific to the feature.
17-
* In the branch you do work specific to the feature.
18-
* Please also observe the following:
19-
* No reformatting
20-
* No changing files that are not specific to the feature
21-
* More covered below in the **Prepare commits** section.
22-
* Test your changes and please help us out by updating and implementing some automated tests. It is recommended that all contributors spend some time looking over the tests in the source code. You can't go wrong emulating one of the existing tests and then changing it specific to the behavior you are testing.
23-
* Please do not update your branch from the master unless we ask you to. See the responding to feedback section below.
14+
* You create, or update, a fork of GitTools/GitReleaseManager under your GitHub account.
15+
* From there you create a branch named specific to the feature.
16+
* In the branch you do work specific to the feature.
17+
* Please also observe the following:
18+
* No reformatting
19+
* No changing files that are not specific to the feature
20+
* More covered below in the **Prepare commits** section.
21+
* Test your changes and please help us out by updating and implementing some automated tests. It is recommended that all contributors spend some time looking over the tests in the source code. You can't go wrong emulating one of the existing tests and then changing it specific to the behavior you are testing.
22+
* Please do not update your branch from the master unless we ask you to. See the responding to feedback section below.
2423

2524
### Prepare Commits
2625

2726
This section serves to help you understand what makes a good commit.
2827

2928
A commit should observe the following:
3029

31-
* A commit is a small logical unit that represents a change.
32-
* Should include new or changed tests relevant to the changes you are making.
33-
* No unnecessary whitespace. Check for whitespace with `git diff --check` and `git diff --cached --check` before commit.
34-
* You can stage parts of a file for commit.
30+
* A commit is a small logical unit that represents a change.
31+
* Should include new or changed tests relevant to the changes you are making.
32+
* No unnecessary whitespace. Check for whitespace with `git diff --check` and `git diff --cached --check` before commit.
33+
* You can stage parts of a file for commit.
3534

3635
A commit message should observe the following:
3736

38-
* The first line of the commit message should be a short description around 50 characters in length and be prefixed with the GitHub issue it refers to with parentheses surrounding that. If the GitHub issue is #25, you should have `(GH-25)` prefixed to the message.
39-
* If the commit is about documentation, the message should be prefixed with `(doc)`.
40-
* If it is a trivial commit or one of formatting/spaces fixes, it should be prefixed with `(maint)`.
41-
* After the subject, skip one line and fill out a body if the subject line is not informative enough.
42-
* The body:
43-
* Should indent at `72` characters.
44-
* Explains more fully the reason(s) for the change and contrasts with previous behavior.
45-
* Uses present tense. "Fix" versus "Fixed".
37+
* The first line of the commit message should be a short description around 50 characters in length and be prefixed with the GitHub issue it refers to with parentheses surrounding that. If the GitHub issue is #25, you should have `(GH-25)` prefixed to the message.
38+
* If the commit is about documentation, the message should be prefixed with `(doc)`.
39+
* If it is a trivial commit or one of formatting/spaces fixes, it should be prefixed with `(maint)`.
40+
* After the subject, skip one line and fill out a body if the subject line is not informative enough.
41+
* The body:
42+
* Should indent at `72` characters.
43+
* Explains more fully the reason(s) for the change and contrasts with previous behavior.
44+
* Uses present tense. "Fix" versus "Fixed".
4645

4746
A good example of a commit message is as follows:
4847

49-
```
48+
```shell
5049
(GH-7) Installation Adds All Required Folders
5150

5251
Previously the installation script worked for the older version of
@@ -62,15 +61,15 @@ choco client properly.
6261

6362
Prerequisites:
6463

65-
* You are making commits in a feature branch.
66-
* All specs should be passing.
64+
* You are making commits in a feature branch.
65+
* All specs should be passing.
6766

6867
Submitting PR:
6968

70-
* Once you feel it is ready, submit the pull request to the `GitTools/GitReleaseManager` repository against the ````develop```` branch ([more information on this can be found here](https://help.github.com/articles/creating-a-pull-request)).
71-
* In the pull request, outline what you did and point to specific conversations (as in URLs) and issues that you are are resolving. This is a tremendous help for us in evaluation and acceptance.
72-
* Once the pull request is in, please do not delete the branch or close the pull request (unless something is wrong with it).
73-
* One of the Team members, or one of the committers, will evaluate it within a reasonable time period (which is to say usually within 2-4 weeks). Some things get evaluated faster or fast tracked. We are human and we have active lives outside of open source so don't fret if you haven't seen any activity on your pull request within a month or two. We don't have a Service Level Agreement (SLA) for pull requests. Just know that we will evaluate your pull request.
69+
* Once you feel it is ready, submit the pull request to the `GitTools/GitReleaseManager` repository against the ````develop```` branch ([more information on this can be found here](https://help.github.com/articles/creating-a-pull-request)).
70+
* In the pull request, outline what you did and point to specific conversations (as in URLs) and issues that you are are resolving. This is a tremendous help for us in evaluation and acceptance.
71+
* Once the pull request is in, please do not delete the branch or close the pull request (unless something is wrong with it).
72+
* One of the Team members, or one of the committers, will evaluate it within a reasonable time period (which is to say usually within 2-4 weeks). Some things get evaluated faster or fast tracked. We are human and we have active lives outside of open source so don't fret if you haven't seen any activity on your pull request within a month or two. We don't have a Service Level Agreement (SLA) for pull requests. Just know that we will evaluate your pull request.
7473

7574
### Respond to Feedback on Pull Request
7675

@@ -80,18 +79,18 @@ If we have comments or questions when we do evaluate it and receive no response,
8079

8180
Sometimes we may need you to rebase your commit against the latest code before we can review it further. If this happens, you can do the following:
8281

83-
* `git fetch upstream` (upstream would be the mainstream repo or `GitTools/GitReleaseManager` in this case)
84-
* `git checkout develop`
85-
* `git rebase upstream/develop`
86-
* `git checkout your-branch`
87-
* `git rebase develop`
88-
* Fix any merge conflicts
89-
* `git push origin your-branch` (origin would be your GitHub repo or `your-github-username/GitReleaseManager` in this case). You may need to `git push origin your-branch --force` to get the commits pushed. This is generally acceptable with topic branches not in the mainstream repository.
82+
* `git fetch upstream` (upstream would be the mainstream repo or `GitTools/GitReleaseManager` in this case)
83+
* `git checkout develop`
84+
* `git rebase upstream/develop`
85+
* `git checkout your-branch`
86+
* `git rebase develop`
87+
* Fix any merge conflicts
88+
* `git push origin your-branch` (origin would be your GitHub repo or `your-github-username/GitReleaseManager` in this case). You may need to `git push origin your-branch --force` to get the commits pushed. This is generally acceptable with topic branches not in the mainstream repository.
9089

9190
The only reasons a pull request should be closed and resubmitted are as follows:
9291

93-
* When the pull request is targeting the wrong branch (this doesn't happen as often).
94-
* When there are updates made to the original by someone other than the original contributor. Then the old branch is closed with a note on the newer branch this supersedes #github_number.
92+
* When the pull request is targeting the wrong branch (this doesn't happen as often).
93+
* When there are updates made to the original by someone other than the original contributor. Then the old branch is closed with a note on the newer branch this supersedes #github_number.
9594

9695
## Other General Information
9796

0 commit comments

Comments
 (0)