| Message ID | e2ebacd20a0e33967ccf02918505c8a8cedc95ab.1577733361.git.lars.kurth@citrix.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | Code of Conduct + Extra Guides and Best Practices + VOTE | expand |
On 30.12.19 20:32, Lars Kurth wrote: > From: Lars Kurth <lars.kurth@citrix.com> > > This document is a portal page that lays out our gold standard, > best practices for some common situations and mechanisms to help > resolve issues that can have a negative effect on our community. > > Detail is covered in subsequent documents > > Changes since v3 > - Also changes the TODO in code-of-conduct.md which had been lost > in v2 > > Changes since v2 (introduced in v2) > - Make lines break at 80 characters > > 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 > --- > code-of-conduct.md | 4 +-- > communication-guide.md | 67 ++++++++++++++++++++++++++++++++++++++++++++++++++ > 2 files changed, 69 insertions(+), 2 deletions(-) > create mode 100644 communication-guide.md > > diff --git a/code-of-conduct.md b/code-of-conduct.md > index 7c29a4f..a6080cd 100644 > --- a/code-of-conduct.md > +++ b/code-of-conduct.md > @@ -14,7 +14,7 @@ personal appearance, race, religion, or sexual identity and orientation. > We believe that a Code of Conduct can help create a harassment-free environment, > but is not sufficient to create a welcoming environment on its own: guidance on > creating a welcoming environment, how to communicate in an effective and > -friendly way, etc. can be found [here][guidance]. > +friendly way, etc. can be found [here][guidance]]. > > Examples of unacceptable behavior by participants include: > > @@ -85,7 +85,7 @@ version 1.4, available at > https://www.contributor-covenant.org/version/1/4/code-of-conduct.html > > [homepage]: https://www.contributor-covenant.org > -[guidance]: TODO-INSERT-URL > +[guidance]: communication-guide.md > > For answers to common questions about this code of conduct, see > https://www.contributor-covenant.org/faq > diff --git a/communication-guide.md b/communication-guide.md > new file mode 100644 > index 0000000..153b100 > --- /dev/null > +++ b/communication-guide.md > @@ -0,0 +1,67 @@ > +# Communication Guide > + > +We believe that our [Code of Conduct](code-of-conduct.md) can help create a > +harassment-free environment, but is not sufficient to create a welcoming > +environment on its own. We can all make mistakes: when we do, we take > +responsibility for them and try to improve. > + > +This document lays out our gold standard, best practices for some common > +situations and mechanisms to help resolve issues that can have a > +negative effect on our community. > + > +## Goal > + > +We want a productive, welcoming and agile community that can welcome new > +ideas in a complex technical field which is able to reflect on and improve how > +we work. > + > +## Communication & Handling Differences in Opinions > + > +Examples of behavior that contributes to creating a positive environment > +include: > +* Use welcoming and inclusive language > +* Keep discussions technical and actionable > +* Be respectful of differing viewpoints and experiences > +* Be aware of your own and counterpart’s communication style and culture > +* Gracefully accept constructive criticism > +* Focus on what is best for the community > +* Show empathy towards other community members > +* Resolve differences in opinion effectively > + > +## Getting Help > + > +When developing code collaboratively, technical discussion and disagreements > +are unavoidable. Our contributors come from different countries and cultures, > +are driven by different goals and take pride in their work and in their point > +of view. This invariably can lead to lengthy and unproductive debate, > +followed by indecision, sometimes this can impact working relationships > +or lead to other issues that can have a negative effect on our community. > + > +To minimize such issue, we provide a 3-stage process > +* Self-help as outlined in this document > +* Ability to ask for an independent opinion or help in private > +* Mediation between parties which disagree. In this case a neutral community > + member assists the disputing parties resolve the issues or will work with the > + parties such that they can improve future interactions. > + > +If you need and independent opinion or help, feel free to contact s/and/an/ > +mediation@xenproject.org. The team behind mediation@ is made up of the > +same community members as those listed in the Conduct Team: see > +[Code of Conduct](code-of-conduct.md). In addition, team members are obligated > +to maintain confidentiality with regard discussions that take place. If you > +have concerns about any of the members of the mediation@ alias, you are > +welcome to contact precisely the team member(s) of your choice. In this case, > +please make certain that you highlight the nature of a request by making sure > +that either help or mediation is mentioned in the e-mail subject or body. > + > +## Specific Topics and Best Practice > + > +* [Code Review Guide](code-review-guide.md): > + Essential reading for code reviewers and contributors > +* [Communication Best Practice](communication-practice.md): > + This guide covers communication guidelines for code reviewers and authors. > + It should help you create self-awareness, anticipate, avoid and help resolve > + communication issues. > +* [Resolving Disagreement](resolving-disagreement.md): > + This guide lays out common situations that can lead to dead-lock and shows > + common patterns on how to avoid and resolve issues. Juergen
diff --git a/code-of-conduct.md b/code-of-conduct.md index 7c29a4f..a6080cd 100644 --- a/code-of-conduct.md +++ b/code-of-conduct.md @@ -14,7 +14,7 @@ personal appearance, race, religion, or sexual identity and orientation. We believe that a Code of Conduct can help create a harassment-free environment, but is not sufficient to create a welcoming environment on its own: guidance on creating a welcoming environment, how to communicate in an effective and -friendly way, etc. can be found [here][guidance]. +friendly way, etc. can be found [here][guidance]]. Examples of unacceptable behavior by participants include: @@ -85,7 +85,7 @@ version 1.4, available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html [homepage]: https://www.contributor-covenant.org -[guidance]: TODO-INSERT-URL +[guidance]: communication-guide.md For answers to common questions about this code of conduct, see https://www.contributor-covenant.org/faq diff --git a/communication-guide.md b/communication-guide.md new file mode 100644 index 0000000..153b100 --- /dev/null +++ b/communication-guide.md @@ -0,0 +1,67 @@ +# Communication Guide + +We believe that our [Code of Conduct](code-of-conduct.md) can help create a +harassment-free environment, but is not sufficient to create a welcoming +environment on its own. We can all make mistakes: when we do, we take +responsibility for them and try to improve. + +This document lays out our gold standard, best practices for some common +situations and mechanisms to help resolve issues that can have a +negative effect on our community. + +## Goal + +We want a productive, welcoming and agile community that can welcome new +ideas in a complex technical field which is able to reflect on and improve how +we work. + +## Communication & Handling Differences in Opinions + +Examples of behavior that contributes to creating a positive environment +include: +* Use welcoming and inclusive language +* Keep discussions technical and actionable +* Be respectful of differing viewpoints and experiences +* Be aware of your own and counterpart’s communication style and culture +* Gracefully accept constructive criticism +* Focus on what is best for the community +* Show empathy towards other community members +* Resolve differences in opinion effectively + +## Getting Help + +When developing code collaboratively, technical discussion and disagreements +are unavoidable. Our contributors come from different countries and cultures, +are driven by different goals and take pride in their work and in their point +of view. This invariably can lead to lengthy and unproductive debate, +followed by indecision, sometimes this can impact working relationships +or lead to other issues that can have a negative effect on our community. + +To minimize such issue, we provide a 3-stage process +* Self-help as outlined in this document +* Ability to ask for an independent opinion or help in private +* Mediation between parties which disagree. In this case a neutral community + member assists the disputing parties resolve the issues or will work with the + parties such that they can improve future interactions. + +If you need and independent opinion or help, feel free to contact +mediation@xenproject.org. The team behind mediation@ is made up of the +same community members as those listed in the Conduct Team: see +[Code of Conduct](code-of-conduct.md). In addition, team members are obligated +to maintain confidentiality with regard discussions that take place. If you +have concerns about any of the members of the mediation@ alias, you are +welcome to contact precisely the team member(s) of your choice. In this case, +please make certain that you highlight the nature of a request by making sure +that either help or mediation is mentioned in the e-mail subject or body. + +## Specific Topics and Best Practice + +* [Code Review Guide](code-review-guide.md): + Essential reading for code reviewers and contributors +* [Communication Best Practice](communication-practice.md): + This guide covers communication guidelines for code reviewers and authors. + It should help you create self-awareness, anticipate, avoid and help resolve + communication issues. +* [Resolving Disagreement](resolving-disagreement.md): + This guide lays out common situations that can lead to dead-lock and shows + common patterns on how to avoid and resolve issues.