From: Lars Kurth <lars.kurth@citrix.com>
To: Jan Beulich <jbeulich@suse.com>, Lars Kurth <lars.kurth@xenproject.org>
Cc: "xen-api@lists.xenproject.org" <xen-api@lists.xenproject.org>,
"minios-devel@lists.xenproject.org"
<minios-devel@lists.xenproject.org>,
"committers@xenproject.org" <committers@xenproject.org>,
"mirageos-devel@lists.xenproject.org"
<mirageos-devel@lists.xenproject.org>,
"xen-devel@lists.xenproject.org" <xen-devel@lists.xenproject.org>,
"win-pv-devel@lists.xenproject.org"
<win-pv-devel@lists.xenproject.org>
Subject: Re: [Xen-devel] [PATCH v2 5/6] Add guide on Communication Best Practice
Date: Fri, 27 Sep 2019 10:22:13 +0000 [thread overview]
Message-ID: <DBFDB335-D9DB-4AE3-AD5B-20C8E92AFD60@citrix.com> (raw)
In-Reply-To: <FB6109D7-6FDC-41AF-95F8-3CC65FAA1215@citrix.com>
On 27/09/2019, 11:17, "Lars Kurth" <lars.kurth@citrix.com> wrote:
On 27/09/2019, 10:14, "Jan Beulich" <jbeulich@suse.com> wrote:
On 26.09.2019 21:39, Lars Kurth wrote:
> +### Verbose vs. terse
> +Due to the time it takes to review and compose code reviewer, reviewers often adopt a
> +terse style. It is not unusual to see review comments such as
> +> typo
> +> s/resions/regions/
> +> coding style
> +> coding style: brackets not needed
> +etc.
> +
> +Terse code review style has its place and can be productive for both the reviewer and
> +the author. However, overuse can come across as unfriendly, lacking empathy and
> +can thus create a negative impression with the author of a patch. This is in particular
> +true, when you do not know the author or the author is a newcomer. Terse
> +communication styles can also be perceived as rude in some cultures.
And another remark here: Not being terse in situations like the ones
enumerated as examples above is a double waste of the reviewer's time:
They shouldn't even need to make such comments, especially not many
times for a single patch (see your mention of "overuse"). I realize
we still have no automated mechanism to check style aspects, but
anybody can easily look over their patches before submitting them.
And for an occasional issue I think a terse reply is quite reasonable
to have.
At the end of the day, none if this is mandatory. The document also
has two audiences
* Authors which get review feedback : for example by just having
this section in there it helps
This was meant to read: it helps set expectations and promotes
understanding for some of the patterns used
I added this section primarily because we do see the occasional
very terse review style and even I think sometimes: wow, that comes
across as harsh. But I also know, that it isn't intentional and that
I have a fairly thick skin. And it is not exclusive to typos and minor issues.
Lars
_______________________________________________
Xen-devel mailing list
Xen-devel@lists.xenproject.org
https://lists.xenproject.org/mailman/listinfo/xen-devel
next prev parent reply other threads:[~2019-09-27 10:23 UTC|newest]
Thread overview: 42+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-09-26 19:39 [Xen-devel] [PATCH v2 0/6] Code of Conduct + Extra Guides and Best Practices Lars Kurth
2019-09-26 19:39 ` [Xen-devel] [PATCH v2 1/6] Import v1.4 of Contributor Covenant CoC Lars Kurth
2019-10-07 11:06 ` George Dunlap
2019-10-07 11:27 ` Lars Kurth
2019-09-26 19:39 ` [Xen-devel] [PATCH v2 2/6] Xen Project Code of Conduct Lars Kurth
2019-09-26 19:39 ` [Xen-devel] [PATCH v2 3/6] Add Communication Guide Lars Kurth
2019-09-26 19:39 ` [Xen-devel] [PATCH v2 4/6] Add Code Review Guide Lars Kurth
2019-11-28 0:54 ` Stefano Stabellini
2019-11-28 10:09 ` Jan Beulich
2019-11-28 13:06 ` Lars Kurth
2019-11-28 13:37 ` Jan Beulich
2019-11-28 14:02 ` Lars Kurth
2019-11-28 18:20 ` [Xen-devel] [MirageOS-devel] " Rich Persaud
2019-11-29 1:39 ` Lars Kurth
2019-12-05 23:41 ` Lars Kurth
2019-12-06 9:51 ` [Xen-devel] " Jan Beulich
2019-12-09 11:02 ` Lars Kurth
2019-12-09 15:58 ` Lars Kurth
2019-11-28 18:12 ` Rich Persaud
2019-11-29 1:50 ` Lars Kurth
2019-11-28 18:19 ` Stefano Stabellini
2019-09-26 19:39 ` [Xen-devel] [PATCH v2 5/6] Add guide on Communication Best Practice Lars Kurth
2019-09-27 8:59 ` Jan Beulich
2019-09-27 9:53 ` Lars Kurth
2019-09-27 9:14 ` Jan Beulich
2019-09-27 10:17 ` Lars Kurth
2019-09-27 10:22 ` Lars Kurth [this message]
2019-09-27 14:19 ` Jan Beulich
2019-10-07 16:13 ` George Dunlap
2019-10-08 7:29 ` Jan Beulich
2019-11-28 1:06 ` Stefano Stabellini
2019-11-29 0:02 ` Lars Kurth
2019-10-07 15:29 ` George Dunlap
2019-11-28 0:57 ` Stefano Stabellini
2019-11-29 0:00 ` Lars Kurth
2019-09-26 19:39 ` [Xen-devel] [PATCH v2 6/6] Added Resolving Disagreement Lars Kurth
2019-11-28 0:56 ` Stefano Stabellini
2019-11-28 10:18 ` Jan Beulich
2019-11-28 18:50 ` Stefano Stabellini
2019-11-29 2:10 ` Lars Kurth
2019-11-29 1:42 ` Lars Kurth
2019-10-24 7:51 ` [Xen-devel] [PATCH v2 0/6] Code of Conduct + Extra Guides and Best Practices Felipe Huici
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=DBFDB335-D9DB-4AE3-AD5B-20C8E92AFD60@citrix.com \
--to=lars.kurth@citrix.com \
--cc=committers@xenproject.org \
--cc=jbeulich@suse.com \
--cc=lars.kurth@xenproject.org \
--cc=minios-devel@lists.xenproject.org \
--cc=mirageos-devel@lists.xenproject.org \
--cc=win-pv-devel@lists.xenproject.org \
--cc=xen-api@lists.xenproject.org \
--cc=xen-devel@lists.xenproject.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).