Skip to content

Commit

Permalink
Add PR policy exemption for instrgen (#4589)
Browse files Browse the repository at this point in the history
In order to increase development velocity for this new prototype, the
strict restrictions imposed on other modules that have been released in
this repository are lifted. This exemption is only meant to last as long
as the module remains in a prototype phase. Upon its first tagged
release it is expected that these exemption be removed.
  • Loading branch information
MrAlias committed Nov 21, 2023
1 parent f699179 commit 9f26914
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,21 +40,25 @@ Changes should be made using [the GitHub flow](https://guides.github.com/introdu

A pull request is considered ready to merge when the following criteria are meet.

* It has received two approvals from Approvers/Maintainers (at different companies).
* It has received two approvals from Approvers/Maintainers (at different companies), unless the change is for an exempt module[^1].
* All feedback has been addressed. Be sure to "Resolve" all comments that have been addressed to signal this.
* Any substantive changes submitted after an Approval removes that Approval.
You will need to manually clear these prior Approval reviews to indicate to the reviewer that they need to resubmit their review.
This includes changes resulting from other feedback.
Unless the approver explicitly stated that their approval will persist across changes it should be assumed that the pull request needs their review again.
Other project members (e.g. approvers, maintainers) can help with this if there are any questions or if you forget to clear reviews.
* If the changes are not trivial, cosmetic, or for documentation or dependencies only, the pull request will need to be open for review for at least one working day.
* If the changes are not trivial, cosmetic, exempt[^1], or for documentation or dependencies only, the pull request will need to be open for review for at least one working day.
This gives people reasonable time to review.
* `CHANGELOG.md` has been updated to reflect what has been added, changed, removed, or fixed from the end users perspective.
See [how to keep a changelog](https://keepachangelog.com/en/1.0.0/).
* Urgent fixes can take exception as long as it has been actively communicated.

Any Maintainer can merge the pull request once it is ready to merge.

[^1]: The `go.opentelemetry.io/contrib/instrgen` module is exempt from the two approvals and one day requirement.
Only one approval is needed to merge a Pull Request for that module and there is no minimum amout of time required for the PR to be open before merging.
This exemption is to be removed when that package makes its first tagged release.

### Draft Pull Requests

It can be helpful at times to publish your incomplete changes.
Expand Down

0 comments on commit 9f26914

Please sign in to comment.