Skip to content
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

Define when a PR is "ready to merge" #4625

Closed
Closed
Changes from all commits
Commits
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
26 changes: 26 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,32 @@ Please also see [GitHub
workflow](https://github.com/open-telemetry/community/blob/main/CONTRIBUTING.md#github-workflow)
section of general project contributing guide.

### How to Get PRs Merged

A PR is considered to be **ready to merge** when:

* Either of the following are true:
* The PR has received at least two approvals from Collaborators/Maintainers with different employers.
* The PR has received a single approval from a Maintainer *and* there's a pointer to a public discussion where at least two Collaborators/Maintainers with different employers have agreed upon the approach taken.
* Feedback has been addressed.
* Any substantive changes to your PR will require that you clear any prior
Approval reviews, including changes resulting from other feedback. Unless
the approver explicitly stated that their approval will persist across
changes it should be assumed that the PR needs their review again. Other
project members (e.g. approvers, maintainers) can help with this if there are
any questions or if the PR author forgot to clear reviews.
* It has been open for review for at least one working day. This gives
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

my two cents: 24h is pretty short for substantive changes... I usually specify 48h when I'm waiting for final approval on a large/meaningful change.

people reasonable time to review.
* Trivial changes (typo, cosmetic, doc, etc.) do not have to wait for
one day and may be merged with a single Maintainer's approval.
* `CHANGELOG.md` has been updated to reflect what has been
added, changed, removed, or fixed.
* `README.md` has been updated if necessary.
* Urgent fix can take exception as long as it has been actively
communicated.

Any Maintainer can merge the PR once it is **ready to merge**.

## Required Tools

Working with the project sources requires the following tools:
Expand Down