mirrors/git
1
0
Fork 0
mirror of https://github.com/git/git.git synced 2024-10-28 04:49:43 +01:00
Code Activity

ReviewingGuidelines: encourage positive reviews more

Browse source 
I saw some contributors hesitate to give a positive review on
patches by their coworkers.  When written well, a positive review
does not have to be a hollow "looks good" that rubber stamps an
useless approval on a topic that is not interesting to others.

Let's add a few paragraphs to encourage positive reviews, which is a
bit harder to give than a review to point out things to improve.

Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Junio C Hamano 2024-07-25 08:49:34 -07:00
parent c2b3f2b3cd
commit 92e24c8b79
1 changed files with 21 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
Documentation/ReviewingGuidelines.txt
View file

@ -72,12 +72,29 @@ guidance, and concrete tips for interacting with patches on the mailing list.
could fix it. This not only helps the author to understand and fix the issue,
it also deepens and improves your understanding of the topic.
- Reviews do not need to exclusively point out problems. Feel free to "think out
- Reviews do not need to exclusively point out problems. Positive
reviews indicate that it is not only the original author of the
patches who care about the issue the patches address, and are
highly encouraged.
- Do not hesitate to give positive reviews on a series from your
work colleague. If your positive review is written well, it will
not make you look as if you two are representing corporate
interest on a series that is otherwise uninteresting to other
community members and shoving it down their throat.
- Write a positive review in such a way that others can understand
why you support the goal, the approach, and the implementation the
patches took. Make sure to demonstrate that you did thoroughly read
the series and understood problem area well enough to be able to
say that the patches are written well. Feel free to "think out
loud" in your review: describe how you read & understood a complex section of
a patch, ask a question about something that confused you, point out something
you found exceptionally well-written, etc. In particular, uplifting feedback
goes a long way towards encouraging contributors to participate more actively
in the Git community.
you found exceptionally well-written, etc.
- In particular, uplifting feedback goes a long way towards
encouraging contributors to participate more actively in the Git
community.
==== Performing your review
- Provide your review comments per-patch in a plaintext "Reply-All" email to the