You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+16-1Lines changed: 16 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -142,5 +142,20 @@ To ensure smooth collaboration and to maintain a high-quality codebase, please a
142
142
*`git log` can help you find the original/relevant authors of the code you are modifying. If you need, feel free to tag the author in your Pull Request comment if you need assistance or review.
143
143
* Do not re-create a pull-request for the same change. Use one Pull Request related to the same change(s). The purpose here is to keep the history and all comments in the Pull Request.
144
144
* Consider open questions and concerns in all comments of your Pull Request, provide replies and resolve addressed comments, if those don't serve reference purposes. If a comment doesn't contain `nit`, `minor`, or `not a blocker` mention, please provide feedback to the comment before merging.
145
-
*Give time for review. For instance two working days is a good base to get first reviews and comments for changes that are not likely to affect downstream projects. For changes that touch core interfaces and behaviours three working days would be advisable.
145
+
*All changes to REST API specs should be accompanied by an email to the `dev` list for visibility.
146
146
* If you have the feeling that the discussions in a Pull Request are not going to a consensus, feel free to bring the discussion on the dev mailing list.
147
+
148
+
## PR Review Guidelines
149
+
150
+
* Smaller changes that are not likely to affect end users or downstream projects can be merged on
151
+
immediately on approval. If concerns are flagged later, they are to be addressed in follow-up PRs.
152
+
* Waiting at least two working days is recommented (even if the PR has approvals from some reviewers) for:
153
+
- Refactorings that may affect downstream projects.
154
+
- Adding new features even if they are "off" by default.
155
+
* Three working days are recommended in these cases (even if the PR has approvals from some reviewers):
156
+
- Making changes to public classes or methods in `polaris-core`.
157
+
- REST API and user-level configuration changes (including feature flags).
158
+
- Adding new modules to the project.
159
+
* If concerns are raised during the initial review grace period, the PR should remain open until those
160
+
concerns are addressed. If a reviewer becomes unresponsive after raising a concern, and the same grace
161
+
period passes, the matter is to be discussed on the `dev` mailing list.
0 commit comments