Skip to content

Commit 960a56f

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

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

COMMITTERS.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
Committing
2-
==========
1+
# Committing
32

43
We like to see folks contributing to GitReleaseManager. If you are a committer, we'd like to see you help from time to time with triage and the pull request process.
54

@@ -17,25 +16,26 @@ Please be VERY familiar with [CONTRIBUTING](https://github.com/GitTools/GitRelea
1716

1817
## Review Process
1918

20-
#### Receive new PR (pull request)
19+
### Receive new PR (pull request)
2120

22-
* A contributor sends a pull request (usually against master).
23-
* A committer typically reviews it within a week or less to determine the feasibility of the changes.
21+
* A contributor sends a pull request (usually against master).
22+
* A committer typically reviews it within a week or less to determine the feasibility of the changes.
2423

25-
#### Initial PR Review
24+
### Initial PR Review
2625

27-
* Did the user create a branch with these changes? If it is on their master, please ask them to review [CONTRIBUTING](https://github.com/GitTools/GitReleaseManager/blob/develop/CONTRIBUTING.md).
28-
* Did the user reformat files and they should not have? Was is just white-space? You can try adding [?w=1](https://github.com/blog/967-github-secrets) to the URL on GitHub.
29-
* Are there tests? We really want any new contributions to contain tests so unless the committer believes this code really needs to be in the code base and is willing to write the tests, then we need to ask the contributor to make a good faith effort in adding test cases. Ask them to review the [contributing document](https://github.com/GitTools/GitReleaseManager/blob/develop/CONTRIBUTING.md) and provide tests. **Note:** Some commits may be refactoring which wouldn't necessarily add additional test sets.
30-
* Is the code documented properly? Does this additional set of changes require changes to the [documentation](http://gittools.github.io/GitReleaseManager/docs/)?
31-
* Was this code warranted? Did the contributor follow the process of gaining approval for big change sets? If not please have them review the [contributing document](https://github.com/GitTools/GitReleaseManager/blob/develop/CONTRIBUTING.md) and ask them to follow up in the Chat Room.
26+
* Did the user create a branch with these changes? If it is on their master, please ask them to review [CONTRIBUTING](https://github.com/GitTools/GitReleaseManager/blob/develop/CONTRIBUTING.md).
27+
* Did the user reformat files and they should not have? Was is just white-space? You can try adding [?w=1](https://github.com/blog/967-github-secrets) to the URL on GitHub.
28+
* Are there tests? We really want any new contributions to contain tests so unless the committer believes this code really needs to be in the code base and is willing to write the tests, then we need to ask the contributor to make a good faith effort in adding test cases. Ask them to review the [contributing document](https://github.com/GitTools/GitReleaseManager/blob/develop/CONTRIBUTING.md) and provide tests. **Note:** Some commits may be refactoring which wouldn't necessarily add additional test sets.
29+
* Is the code documented properly? Does this additional set of changes require changes to the [documentation](http://gittools.github.io/GitReleaseManager/docs/)?
30+
* Was this code warranted? Did the contributor follow the process of gaining approval for big change sets? If not please have them review the [contributing document](https://github.com/GitTools/GitReleaseManager/blob/develop/CONTRIBUTING.md) and ask them to follow up in the Chat Room.
3231

33-
#### Review the Code
34-
* Does the code meet the naming conventions and formatting (need link)?
35-
* Is the code sound? Does it read well? Can you understand what it is doing without having to execute it? Principal of no clever hacks (need link).
36-
* Does the code do what the purpose of the pull request is for?
32+
### Review the Code
3733

38-
#### Accepting a PR
34+
* Does the code meet the naming conventions and formatting (need link)?
35+
* Is the code sound? Does it read well? Can you understand what it is doing without having to execute it? Principal of no clever hacks (need link).
36+
* Does the code do what the purpose of the pull request is for?
37+
38+
### Accepting a PR
3939

4040
Once you have reviewed the initial items, and are not waiting for additional feedback or work by the contributor, give the thumbs up that it is ready for the next part of the process (merging).
4141

0 commit comments

Comments
 (0)