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: COMMITTERS.md
+16-16Lines changed: 16 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,4 @@
1
-
Committing
2
-
==========
1
+
# Committing
3
2
4
3
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.
5
4
@@ -17,25 +16,26 @@ Please be VERY familiar with [CONTRIBUTING](https://github.com/GitTools/GitRelea
17
16
18
17
## Review Process
19
18
20
-
####Receive new PR (pull request)
19
+
### Receive new PR (pull request)
21
20
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.
24
23
25
-
####Initial PR Review
24
+
### Initial PR Review
26
25
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://gitreleasemanager.readme.io/)?
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.
32
31
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
37
33
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
39
39
40
40
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).
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+42-43Lines changed: 42 additions & 43 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,52 +1,51 @@
1
-
Contributors
2
-
============
1
+
# Contributors
3
2
4
3
## Contributing Process
5
4
6
5
### Get Buyoff Or Find Open Community Issues/Features
7
6
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.
12
11
13
12
### Set Up Your Environment
14
13
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.
24
23
25
24
### Prepare Commits
26
25
27
26
This section serves to help you understand what makes a good commit.
28
27
29
28
A commit should observe the following:
30
29
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.
35
34
36
35
A commit message should observe the following:
37
36
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".
46
45
47
46
A good example of a commit message is as follows:
48
47
49
-
```
48
+
```shell
50
49
(GH-7) Installation Adds All Required Folders
51
50
52
51
Previously the installation script worked for the older version of
@@ -62,15 +61,15 @@ choco client properly.
62
61
63
62
Prerequisites:
64
63
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.
67
66
68
67
Submitting PR:
69
68
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.
74
73
75
74
### Respond to Feedback on Pull Request
76
75
@@ -80,18 +79,18 @@ If we have comments or questions when we do evaluate it and receive no response,
80
79
81
80
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:
82
81
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.
90
89
91
90
The only reasons a pull request should be closed and resubmitted are as follows:
92
91
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.
0 commit comments