Skip to content

Define roles and their responsibilities in a PR #3168

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lzybkr merged 7 commits into from
Feb 23, 2017
Merged

Define roles and their responsibilities in a PR #3168

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
a5901da
Define roles and their responsibilities in a PR
daxian-dbw Feb 17, 2017
38b03e8
Fix grammar issues in the text change
daxian-dbw Feb 17, 2017
bc7c82a
Fix some more grammar issues
daxian-dbw Feb 18, 2017
8ae5c75
one more fix
daxian-dbw Feb 20, 2017
c9f1bf5
Address review comments
daxian-dbw Feb 21, 2017
a04ca85
Address Joey's comments
daxian-dbw Feb 22, 2017
e66f55a
Caps 'C' in 'Collaborator'
daxian-dbw Feb 22, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 30 additions & 8 deletions .github/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Contributing to Issues
[open a new issue](https://github.com/PowerShell/PowerShell/issues/new),
making sure to follow the directions as best you can.
* If the issue is marked as [`Up-for-Grabs`][up-for-grabs],
the PowerShell maintainers are looking for help with the issue.
the PowerShell Maintainers are looking for help with the issue.

Contributing to Documentation
-----------------------------
Expand Down Expand Up @@ -127,7 +127,7 @@ See [Contributing to documentation related to PowerShell](#contributing-to-docum
either update the changelog in your pull request or
add a comment in the PR description saying that the change may warrant a note in the changelog.
New changes always go into the **Unreleased** section.
Keeping the changelog up-to-date simplifies the release process for maintainers.
Keeping the changelog up-to-date simplifies the release process for Maintainers.
An example:
```
Unreleased
Expand Down Expand Up @@ -169,12 +169,34 @@ See [Contributing to documentation related to PowerShell](#contributing-to-docum

#### Pull Request - Code Review

* After a successful test pass,
the area maintainers will do a code review,
commenting on any changes that might need to be made.
* Roles and Responsibilities of a PR: Author, Reviewer, and Assignee
* Reviewer and Assignee are two separate roles of a PR.
* A Reviewer can be anyone who wants to contribute.
A Reviewer reviews the change of a PR,
leaves comments for the Author to address,
and approves the PR when the change looks good.
* An Assignee must be a [Maintainer](../docs/maintainers), who monitors the progress of the PR,
coordinates the review process, and merges the PR after it's been approved.
The Assignee may or may not be a Reviewer of the PR at the same time.
* An Author is encouraged to choose Reviewer(s) and an Assignee for the PR.
If no Assignee is chosen, one of the Maintainers shall be assigned to it.
If no Reviewer is chosen, the Assignee shall choose Reviewer(s) as appropriate.
* If an Author is a [PowerShell Team](https://github.com/orgs/PowerShell/people) member,
then the Author **is required** to choose Reviewer(s) and an Assignee for the PR.
* For a PR to be merged, it must be approved by at least one PowerShell Team member or Collaborator,
so additional Reviewer(s) may be added by the Assignee as appropriate.
The Assignee may also be re-assigned by Maintainers.

* A Reviewer can postpone the code review if CI builds fail,
but also can start the code review early regardless of the CI builds.

* The Author **is responsible** for driving the PR to the Approved state.
The Author addresses review comments, and pings Reviewer(s) to start the next iteration.
If the review is making no progress (or very slow),
the Author can always ask the Assignee to help coordinate the process and keep it moving.

* Additional feedback is always welcome!
Even if you are not designated as an area's maintainer,
Even if you are not designated as a Reviewer,
feel free to review others' pull requests anyway.
Leave your comments even if everything looks good;
a simple "Looks good to me" or "LGTM" will suffice.
Expand All @@ -191,9 +213,9 @@ See [Contributing to documentation related to PowerShell](#contributing-to-docum
* Once the code review is done,
all merge conflicts are resolved,
and the CI system build status is passing,
a maintainer will merge your changes.
the PR Assignee will merge your changes.

* For more information on the the PowerShell maintainers' process,
* For more information on the the PowerShell Maintainers' process,
see the [documentation](../docs/maintainers).

Making Breaking Changes
Expand Down
7 changes: 7 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
<!--

If you are a [PowerShell Team](https://github.com/orgs/PowerShell/people) member, please make sure you choose the Reviewer(s) and Assignee for your PR.
If you are not part of the PowerShell Team, you can leave the fields blank and the Maintainers will choose them for you. If you are familiar with the team, feel free to add some Reviewers yourself.
For more information about the roles of Reviewer and Assignee, refer to [CONTRIBUTING.md](CONTRIBUTING.md#pull-request---code-review)

-->