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

Create PR-Review process #8

Closed
wants to merge 5 commits into from
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
29 changes: 29 additions & 0 deletions pr-reviews.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
## PR Review process
This document formalizes the process related to PR Review processes

### Scope
- This document applies to all repositories within the NeoForged organization.
- This document applies to all pull requests within the repositories that this document applies to.

#### Exclusions
- The governance repository

Labels applied to pull requests can be used to indicate that this document is not applicable.
This document can specify labels where it does not apply or for which a different process is applicable.

### Process description
This document describes the bare minimum process that needs to be followed by all parties involved to get a PR accepted.

1. It should be validated that all pull requests come with a sufficiently descriptive message. This message should include, but should not be limited to:
1. A short introduction as to why the change was made.
2. Whether tests were performed;
1. If they were performed, which ones and what was the outcome?
2. If not, why not?
3. What needs to be communicated to the public? Examples include:
1. Changes in API surface or code behavior
2. Changes to project deployment
3. Changes to project consumption (GAV changes etc.)

If nothing needs to be communicated, this must also be stated with reasoning.
2. All pull requests not scoped to fixing an issue or deemed to have a sufficiently large impact by at least one maintainer require a cooling-off period between the last commit and the merge of at least 72 hours. Even if approving reviews are given in the meantime.
3. The dismissal of a review should, at all costs, be avoided. However, if it is foreseeable that a reviewer is not able to review a pull request again due to time constraints on his or her part, then after a sufficiently long waiting period and a discussion between maintainers, the review can be dismissed.