-
Notifications
You must be signed in to change notification settings - Fork 199
Contributor docs: write up merge practices #1830
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
Merged
Merged
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
a41c3fe
Contributor docs: write up merge practices
ddbeck 80f65f3
Elaborate on how review requests ought to be interpreted
ddbeck 4f54103
Apply suggestions from code review
ddbeck fefab53
Add step suggested by @jamesnw
ddbeck 3f3f862
Add periods to complete sentences
ddbeck 14ac897
Link to GitHub dismiss stale review docs
ddbeck eab4c22
Cross-reference reviewing in `CONTRIBUTING.md`
ddbeck 38d96d1
Cross-reference reviewing in `./README.md`
ddbeck File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| # Pull request and issue management | ||
|
|
||
| ## Merging pull requests | ||
|
|
||
| > [!NOTE] | ||
| > This information is for [project peers and owners](../GOVERNANCE.md#roles-and-responsibilities). | ||
|
|
||
| If a pull request has been approved and tests are passing, then you can merge it. | ||
| Follow these steps to merge: | ||
|
|
||
| 1. Make sure you **should** merge this pull request. | ||
| In general, only merge pull requests you are already familiar with, either as an author or reviewer. | ||
|
|
||
| 1. Make sure **you** should merge this pull request. | ||
| Some changes—most notably, feature removals, tooling and policy changes, and schema changes—require an owner to merge. | ||
| See [the privileges and responsibilities matrix](../GOVERNANCE.md#privileges-and-responsibilities-matrix) for more information. | ||
|
|
||
| 1. Make sure there are no explicit blockers to merging. | ||
| Blockers include: | ||
|
|
||
| - The pull request has the [blocked label](https://github.com/web-platform-dx/web-features/pulls?q=is%3Aopen+is%3Apr+label%3Ablocked). | ||
| - A reviewer asked to re-review before merging or has requested changes that have not been addressed with a commit or comment. | ||
| - The author explicitly asked to delay merging. | ||
| - The author explicitly asked for review from all requested reviewers (the presumption is at least one but not all). | ||
|
|
||
| If a blocker no longer applies, remove the label or [dismiss the stale review](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/dismissing-a-pull-request-review). | ||
|
|
||
| 1. If the pull request might require a Semantic Versioning MAJOR or MINOR release, then add the [minor version required](https://github.com/web-platform-dx/web-features/labels/minor%20version%20required) or [major version required](https://github.com/web-platform-dx/web-features/labels/major%20version%20required) label. | ||
|
|
||
| 1. Click the **Squash and merge** button, then prepare the commit message. | ||
|
|
||
| Clean up the subject and message fields so they make sense as a single unit. | ||
| For example, delete boilerplate messages about applying changes from code review. | ||
| Often an imperative-noun subject, such as "Add example feature", is sufficient. | ||
|
|
||
| 1. When you're ready to commit the changes, click **Confirm squash and merge**. |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.