Re: [Xen-devel] [PATCH v4 6/7] Add guide on Communication Best Practice

["Jürgen Groß" <jgross@suse.com>]

On 30.12.19 20:32, Lars Kurth wrote:
> From: Lars Kurth <lars.kurth@citrix.com>
> 
> This guide covers the bulk on Best Practice related to code review
> It primarily focusses on code review interactions
> It also covers how to deal with Misunderstandings and Cultural
> Differences
> 
> Changes since v3
> * Fixed typo
> 
> Changes since v2 (added in v2)
> * Fix typos
> * Extended "Verbose vs. terse"
> * Added "Clarity over Verbosity"
> * Broke "Identify the severity of an issue or disagreement" into two chapters
>    - "Identify the severity and optionality of review comments" and made
>      clarifications
>    - "Identify the severity of a disagreement"
>    - Expanded "Prioritize significant flaws"
> * Added "Reviewers: Take account of previous reviewer(s) comments"
> * Added prefixes such as "Reviewers:" where appropriate
> * Fixed lien wrapping to 80 characters
> * Replaced inline links with reference links
> 
> Signed-off-by: Lars Kurth <lars.kurth@citrix.com>
> ---
> Cc: minios-devel@lists.xenproject.org
> Cc: xen-api@lists.xenproject.org
> Cc: win-pv-devel@lists.xenproject.org
> Cc: mirageos-devel@lists.xenproject.org
> Cc: committers@xenproject.org
> ---
>   communication-practice.md | 504 ++++++++++++++++++++++++++++++++++++++++++++++
>   1 file changed, 504 insertions(+)
>   create mode 100644 communication-practice.md
> 
> diff --git a/communication-practice.md b/communication-practice.md
> new file mode 100644
> index 0000000..438b73a
> --- /dev/null
> +++ b/communication-practice.md
> @@ -0,0 +1,504 @@
> +# Communication Best Practice
> +
> +This guide provides communication Best Practice that helps you in
> +* Using welcoming and inclusive language
> +* Keeping discussions technical and actionable
> +* Being respectful of differing viewpoints and experiences
> +* Being aware of your own and counterpart’s communication style and culture
> +* Show empathy towards other community members
> +
> +## Code reviews for **reviewers** and **patch authors**
> +
> +Before embarking on a code review, it is important to remember that
> +* A poorly executed code review can hurt the contributors feeling, even when a
> +  reviewer did not intend to do so. Feeling defensive is a normal reaction to
> +  a critique or feedback. A reviewer should be aware of how the pitch, tone,
> +  or sentiment of their comments could be interpreted by the contributor. The
> +  same applies to responses of an author to the reviewer.
> +* When reviewing someone's code, you are ultimately looking for issues. A good
> +  code reviewer is able to mentally separate finding issues from articulating
> +  code review comments in a constructive and positive manner: depending on your
> +  personality this can be **difficult** and you may need to develop a technique
> +  that works for you.
> +* As software engineers we like to be proud of the solutions we came up with.
> +  This can make it easy to take another people’s criticism personally. Always
> +  remember that it is the code that is being reviewed, not you as a person.
> +* When you receive code review feedback, please be aware that we have reviewers
> +  from different backgrounds, communication styles and cultures. Although we

add "are"

> +  all trying to create a productive, welcoming and agile environment, we do
> +  not always succeed.


Juergen

_______________________________________________
Xen-devel mailing list
Xen-devel@lists.xenproject.org
https://lists.xenproject.org/mailman/listinfo/xen-devel