Skip to content

Commit 7dbcf4c

Browse files
authored
Clarify merge etiquette in Wasmtime (#12408)
Document that we typically expect maintainers themselves to add their own PRs to the merge queue after approval, but clarify that for contributors this is a responsibility of maintainers to add PRs to the merge queue.
1 parent a465eab commit 7dbcf4c

File tree

1 file changed

+30
-6
lines changed

1 file changed

+30
-6
lines changed

docs/contributing-development-process.md

Lines changed: 30 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -68,16 +68,40 @@ If you need help rebasing or merging, please ask!
6868
### Review and merge
6969

7070
Anyone may submit a pull request, and anyone may comment on or review others'
71-
pull requests. However, one review from somebody in the [Core Team] is required
72-
before the Core Team merges it.
73-
74-
Even Core Team members must create PRs and get review from another Core Team
75-
member for every change, including minor work items such as version bumps,
71+
pull requests. However, one approval from a maintainer is required before a PR
72+
can be merged. Maintainers must also create PRs and get review from another
73+
maintainer for every change, including minor work items such as version bumps,
7674
removing warnings, etc.
7775

76+
PR approvals may come with comments about additional minor changes that are
77+
requested. Contributors and maintainers alike should address these comments, if
78+
any, and then the PR is ready for merge. Wasmtime uses a [merge queue] to ensure
79+
that all tests pass before pushing to `main`. Note that the [merge queue] will
80+
run more tests than is run on PRs by default.
81+
82+
Contributors should expect Wasmtime maintainers to add the PR to the merge queue
83+
for them. If a PR hasn't been added, and it's approved with all comments
84+
addressed, feel free to leave a comment to notify maintainers that it's ready.
85+
Maintainers can add their own PRs to the merge queue. When approving a PR
86+
maintainers may also add the PR to the merge queue at that time if there are no
87+
remaining comments.
88+
89+
Note that if CI is failing on a PR then GitHub will automatically block adding a
90+
PR to the [merge queue]. PR authors will need to resolve PR CI before it can be
91+
added to the merge queue. If the merge queue CI fails then the PR will be
92+
removed from the merge queue and GitHub will leave a marker on the timeline and
93+
send a notification to the PR author. PR authors are expected to review CI logs
94+
and fix any failures in the PR itself. When ready maintainers can re-add their
95+
own PR for minor fixes and contributors can leave a comment saying that the PR
96+
is ready to be re-added to the queue.
97+
98+
To run full CI on the PR before the merge queue, include the string
99+
`prtest:full` in any commit in the PR. That can help debug CI failures without
100+
going through the merge queue if necessary.
101+
78102
[issues]: https://guides.github.com/features/issues/
79103
[pull requests]: https://help.github.com/articles/about-pull-requests/
80104
[issue keywords]: https://help.github.com/articles/closing-issues-using-keywords/
81-
[Core Team]: https://github.com/orgs/bytecodealliance/people/
82105
[newissue]: https://github.com/bytecodealliance/wasmtime/issues/new
83106
[meetings]: https://github.com/bytecodealliance/meetings/tree/main/wasmtime
107+
[merge queue]: https://github.com/bytecodealliance/wasmtime/queue/main

0 commit comments

Comments
 (0)