w3c / PWETF

Positive Work Environment Community Group
https://www.w3.org/community/pwe/
Other
118 stars 68 forks source link

Include an up-front overview of the code #230

Closed dbooth-boston closed 1 year ago

dbooth-boston commented 1 year ago

This issue separates out (and supersedes) suggestion 9 from https://github.com/w3c/PWETF/issues/228 .

BACKGROUND: The CEPC document is already long. Although it has lots of good details and examples, they all boil down to a few general principles, which would be helpful to explicitly summarize up front. This would reinforce the purpose of the document, aid readers who do not have time to read the whole document; and help it feel less like a long laundry list of "do's" and "don'ts".

SUGGESTION: In section 3 (Code), before section 3.1 insert a simple overview of the code, such as the following (derived from the WHATWG Code of Conduct https://whatwg.org/code-of-conduct ):

[[ This code of conduct can be summarized as follows:

The remainder of this document further articulates these expectations and provides guidance for handling violations. ]]

In accordance with the CC-BY license, we would also need to add an acknowledgement at the end of the CEPC, stating that portions were derived from the WHATWG Code of Conduct.

TzviyaSiegman commented 1 year ago

decided not to include an overview