Skip to content

Commit

Permalink
clarify responsibilities for the person clicking "merge" (#10077)
Browse files Browse the repository at this point in the history
  • Loading branch information
Ekleog-NEAR authored Nov 7, 2023
1 parent 984c935 commit 3e7accf
Showing 1 changed file with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,10 @@ following steps when creating a PR:
need to pass before a PR can be merged.
2. When all the comments from the reviewer(s) have been addressed, they should
approve the PR allowing a PR to be merged.
3. An approved PR can be merged by clicking the "Merge when ready" button. The
3. Before merging a PR, the code should be reviewed properly. In particular, the
person who clicks "Merge when ready" has specific duties, exposed in the last
paragraph of the "Code review process" section below.
4. An approved PR can be merged by clicking the "Merge when ready" button. The
button can be clicked by the author if they have the appropriate access, or by a
reviewer otherwise. PR authors can also click the button immediately after filing
a PR; removing an additional round-trip after the PR gets approved. The PR author
Expand Down Expand Up @@ -136,6 +139,16 @@ the existing super owners will discuss and approve the addition. These
discussions take place on zulip so if you are interested in becoming a
code reviewer, please reach out to us there.

The person who clicks the "Merge when ready" button is the one who
guarantees that no unreviewed code was added between the approving review
and the commit that is being landed. They must be especially careful of
commits that might have happened before the review, but not have been
reviewed (eg. because the review was already in progress), as they will
show above the review line on the GitHub UI. In addition, not refreshing
the page might lead to these commits just not displaying, so the reviewer
should refresh the page both before and after clicking "Merge when ready,"
and confirm that the commits are as expected.

## Release Schedule

Once your change ends up in master, it will be released with the rest of the
Expand Down

0 comments on commit 3e7accf

Please sign in to comment.