-
Notifications
You must be signed in to change notification settings - Fork 662
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.
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
Add instruction for maintainer permissions #174
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Couple nits about markdown formatting and some suggestions on phrasing/expectations
Getting-Started.md
Outdated
@@ -75,13 +75,16 @@ Once you've confirmed that your set is passing checks in your local branch, you | |||
|
|||
2. [Create a PR](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) to pull your branch into the master. | |||
|
|||
1. You may need to resolve merge conflicts. | |||
3. You may need to resolve merge conflicts. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
IMO all of these should be 1.
, to take advantage of Markdown's automatic numbering (so we don't have to manually update it for PRs like this).
You can see that Markdown doesn't actually care that this is 1.
in the current version, it still renders it as 3.
in the generated output. The rest of the numbering is also correct in the rendered output, despite being wrong in the current .md source file.
Getting-Started.md
Outdated
2. Check the "Actions" tab to confirm the status of the run triggered by your request. | ||
6. Check the "Actions" tab to confirm the status of the run triggered by your request. | ||
|
||
7. [Enable upstream repository maintainer permissions on your pull request.](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/allowing-changes-to-a-pull-request-branch-created-from-a-fork#enabling-repository-maintainer-permissions-on-existing-pull-requests) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
7. [Enable upstream repository maintainer permissions on your pull request.](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/allowing-changes-to-a-pull-request-branch-created-from-a-fork#enabling-repository-maintainer-permissions-on-existing-pull-requests) | |
7. If you want your PR to be merged in a timely manner, please [enable repository maintainer permissions on your pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/allowing-changes-to-a-pull-request-branch-created-from-a-fork#enabling-repository-maintainer-permissions-on-existing-pull-requests). |
Getting-Started.md
Outdated
6. Check the "Actions" tab to confirm the status of the run triggered by your request. | ||
|
||
7. [Enable upstream repository maintainer permissions on your pull request.](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/allowing-changes-to-a-pull-request-branch-created-from-a-fork#enabling-repository-maintainer-permissions-on-existing-pull-requests) | ||
This will allow the maintainers of the RWS repo to resolve any conflicts and merge your pull request when the time comes. If you do not do this and a conflict exists at time of merge, the maintainers will have to wait for <b>you</b> to resolve this before they can merge it, even if it is otherwise passing the checks. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This will allow the maintainers of the RWS repo to resolve any conflicts and merge your pull request when the time comes. If you do not do this and a conflict exists at time of merge, the maintainers will have to wait for <b>you</b> to resolve this before they can merge it, even if it is otherwise passing the checks. | |
This allows the maintainers of the RWS repository to resolve merge conflicts on your behalf. Without this permission, the maintainers must wait for **you** to resolve any conflicts before they can merge your PR, even if it is otherwise passing the checks. This will delay your submission; maintainers will not revisit your PR until the next regular review. |
Looks like you've passed all of the checks! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM! Go ahead and merge when ready.
* Add instruction for maintainer permissions * rephrasing and formatting as advised
We do not currently instruct uploaders to allow the RWS repo maintainers to make changes to their pull requests when they file it. These permissions are needed when there is a merge conflict so that the RWS admin on review can resolve the conflicts and merge the PR when applicable.