George Dunlap [Thu, 10 Sep 2020 16:09:37 +0000 (17:09 +0100)]
Convert resolving-disagreement.md to rst
communication-practice.rst had an incorrect link; it was listed as
being in resolving-disagreements.md, but actually it was in
code-review-guide. Convert this to a normal cross-reference.
Convert titles / sections, lists, quotes, doc references and so on as
before.
Convert figure as appropriate.
Signed-off-by: George Dunlap <george.dunlap@citrix.com>
George Dunlap [Thu, 10 Sep 2020 11:42:50 +0000 (12:42 +0100)]
Convert code-review-guide.md to rst
Convert titles as approproate.
Use inter-doc references for other full docs. Convert other external
links to RST-style references, keeping the labels (3-F). One
exception to this: sphinx noticed that there were two 'D' labels;
rename one to `Shift Left`.
Convert internal link to RST-style reference.
Add spaces so that lists compile correctly.
Remove explicit HTML <br> tags; Make them a separate block to achieve
a similar goal.
Convert "manual" **subsubsection** sections to RST subsubsuctions
(^^^^^).
No textual changes.
Signed-off-by: George Dunlap <george.dunlap@citrix.com>
Lars Kurth [Wed, 15 Jan 2020 18:43:26 +0000 (18:43 +0000)]
Added Resolving Disagreement
This guide provides Best Practice on identifying and resolving
common classes of disagreement
Changes since v4
* Normalized to US English spelling
Changes since v3
* Fixed broken http link (typo)
Changes since v2 (added in v2)
* Fix typos
* Add section: "Issue: Multiple ways to solve a problem"
* Changed line wrapping to 80 characters
* Replaced inline style links with reference style links
Lars Kurth [Mon, 30 Dec 2019 19:10:00 +0000 (19:10 +0000)]
Add guide on Communication Best Practice
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 v4
* Improved section on Inflammatory language
* Conform to US English
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
Lars Kurth [Mon, 30 Dec 2019 19:08:18 +0000 (19:08 +0000)]
Add Code Review Guide
This document highlights what reviewers such as maintainers and committers look
for when reviewing code. It sets expectations for code authors and provides
a framework for code reviewers.
Changes since v4
* Changed to comply with US English
Changes since v3
* Added example under *Workflow from a Reviewer's Perspective* section
* Fixed typos in text introduced in v2
Changes since v2 (introduced in v2)
* Extend introduction
* Add "Code Review Workflow" covering
- "Workflow from a Reviewer's Perspective"
- "Workflow from an Author's Perspective"
- "Problematic Patch Reviews"
* Wrap to 80 characters
* Replace inline links with reference links to make
wrapping easier
Lars Kurth [Mon, 30 Dec 2019 19:03:50 +0000 (19:03 +0000)]
Add Communication Guide
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
Lars Kurth [Wed, 4 Sep 2019 17:58:25 +0000 (18:58 +0100)]
Xen Project Code of Conduct
Specific changes to the baseline:
* Replace list of positive behaviors with link to separate process
* Replace maintainers with project leadership
(except in our pledge where maintainers is more appropriate)
* Add 'of all sub-projects' to clarify scope of CoC
* Rename Enforcement
* Replace "project team" with "Conduct Team members"
* Add e-mail alias
* Add section on contacting individual Conduct Team members
* Add section on Conduct Team members
projects / people / gdunlap / governance.git / log