snuyanzin commented on code in PR #597:
URL: https://github.com/apache/flink-web/pull/597#discussion_r1114193715
##########
docs/content/how-to-contribute/reviewing-prs.md:
##########
@@ -0,0 +1,89 @@
+---
+title: Review Pull Requests
+bookCollapseSection: false
+weight: 18
+---
+
+# How to Review a Pull Request
+
+This guide is for all committers and contributors that want to help with
reviewing code contributions. Thank you for your effort - good reviews are one
of the most important and crucial parts of an open source project. This guide
should help the community to make reviews such that:
+
+* Contributors have a good contribution experience.
+* Our reviews are structured and check all important aspects of a contribution.
+* We make sure to keep a high code quality in Flink.
+* We avoid situations where contributors and reviewers spend a lot of time
refining a contribution that gets rejected later.
+
+## Review Checklist
+
+Every review needs to check the following six aspects. **We encourage to check
these aspects in order, to avoid spending time on detailed code quality reviews
when formal requirements are not met or there is no consensus in the community
to accept the change.**
+
+### 1. Is the Contribution Well-Described?
+
+Check whether the contribution is sufficiently well-described to support a
good review. Trivial changes and fixes do not need a long description. If the
implementation is exactly [according to a prior discussion on Jira or the
development mainling list]({{< relref "how-to-contribute/contribute-code"
>}}#consensus), only a short reference to that discussion is needed.
Review Comment:
```suggestion
Check whether the contribution is sufficiently well-described to support a
good review. Trivial changes and fixes do not need a long description. If the
implementation is exactly [according to a prior discussion on Jira or the
development mailing list]({{< relref "how-to-contribute/contribute-code"
>}}#consensus), only a short reference to that discussion is needed.
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
