maxmustermann/PowerShell
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Merge pull request #1578 from alexandair/patch-2

Browse source 
Updating maintainers\README
This commit is contained in:
Jason Shirk 2016-08-01 14:34:58 -07:00 committed by GitHub
parent ed2e569c02 ace4f250d2
commit e68d9731dd
1 changed files with 11 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
docs/maintainers/README.md
View file

@ -16,7 +16,7 @@ They have [write access](https://help.github.com/articles/permission-levels-for-
## Rules
If you are maintainer, please follow these rules:
If you are a maintainer, please follow these rules:
1. **DO** reply to new issues and pull requests (while reviewing PRs, leave your comment even if everything looks good - simple "Looks good to me" or "LGTM" will suffice, so that we know someone has already taken a look at it).
1. **DO** make sure contributors are following the [contributor guidelines](../../.github/CONTRIBUTING.md).
@ -25,7 +25,7 @@ If you are maintainer, please follow these rules:
1. **DO** wait for the [CI system][ci-system] build to pass for pull requests.
1. **DO** encourage contributors to refer to issues in PR title/description (e.g. ```Closes #11```). Edit title if necessary.
1. **DO** encourage contributors to create meaningful titles for all PRs. Edit title if necessary.
1. **DO** verify that all contributors are following the [Coding Guidlines](../dev-process/coding-guidelines.md).
1. **DO** verify that all contributors are following the [coding guidelines](../dev-process/coding-guidelines.md).
1. **DO** ensure that each contributor has signed a valid Contributor License Agreement (CLA).
1. **DO** verify compliance with any third party code license terms (e.g., requiring attribution, etc.) if the contribution contains third party code.
@ -42,11 +42,15 @@ Please see [Issue Management Process](./issue-management-process.md)
## Pull Request Workflow
1. A contributor opens a pull request.
2. The contributor ensures that their pull request passes the [CI system][ci-system] build.
- If the build fails, a maintainer adds the ```waiting for author``` label to the pull request. The contributor can then continue to update the pull request until the build passes.
- If the build fails, a maintainer adds the ```waiting for author``` label to the pull request.
The contributor can then continue to update the pull request until the build passes.
2. Once the build passes, the maintainer either reviews the pull request immediately or adds the ```need review``` label.
3. A maintainer or trusted contributor reviews the pull request code.
- If the contributor does not meet the reviewer's standards, the reviewer makes comments. A maintainer then removes the ```need review``` label and adds the ```waiting for author``` label. The contributor must address the comments and repeat from step 2.
- If the contributor meets the reviewer's standards, the reviewer comments that they are satisfied. A maintainer then removes the ```need review``` label.
- If the contributor does not meet the reviewer's standards, the reviewer makes comments.
A maintainer then removes the ```need review``` label and adds the ```waiting for author``` label.
The contributor must address the comments and repeat from step 2.
- If the contributor meets the reviewer's standards, the reviewer comments that they are satisfied.
A maintainer then removes the ```need review``` label.
3. Once the code review is completed, a maintainer merges the pull request.
### Abandoned Pull Requests
@ -58,7 +62,8 @@ In these cases:
- If the contributor responds, it's no longer an abandoned pull request, proceed as normal.
2. If the contributor does not respond **within a week**:
- If the reviewer's comments are very minor, merge the change, fix the code immediately, and create a new PR with the fixes addressing the minor comments.
- If the changes required to merge the pull request are significant but needed, create a new branch with the changes and open an issue to merge the code into the dev branch. Mention the original pull request ID in the description of the new issue and close the abandoned pull request.
- If the changes required to merge the pull request are significant but needed, create a new branch with the changes and open an issue to merge the code into the dev branch.
Mention the original pull request ID in the description of the new issue and close the abandoned pull request.
- If the changes in an abandoned pull request are no longer needed (e.g. due to refactoring of the code base or a design change), simply close the pull request.
[ci-system]: ../testing-guidelines/testing-guidelines.md#ci-system