Simon Horman <[email protected]> writes: > As a community we should strive to be inclusive. > As such it seems appropriate to adopt an word list, > to help guide the use of inclusive language. > > This patch proposes use of the Inclusive Naming Word List v1.0. > > Link: https://inclusivenaming.org/word-lists/ > Signed-off-by: Simon Horman <[email protected]> > ---
I think it's a good practice to adopt a list that gets vetted. I think the inclusive naming initiative is a good choice to adopt. For that: Acked-by: Aaron Conole <[email protected]> Some terms that are on the 'replace immediately' list (such as 'whitelist' and 'abort' - although the latter is considered as not a first-order concern). I guess we should also include some kind of effort to clean these up as well. > Documentation/automake.mk | 1 + > Documentation/index.rst | 1 + > .../contributing/inclusive-language.rst | 58 +++++++++++++++++++ > .../internals/contributing/index.rst | 1 + > 4 files changed, 61 insertions(+) > create mode 100644 > Documentation/internals/contributing/inclusive-language.rst > > diff --git a/Documentation/automake.mk b/Documentation/automake.mk > index 8bd3dbb2b883..47d2e336a0b9 100644 > --- a/Documentation/automake.mk > +++ b/Documentation/automake.mk > @@ -109,6 +109,7 @@ DOC_SOURCE = \ > Documentation/internals/security.rst \ > Documentation/internals/contributing/index.rst \ > Documentation/internals/contributing/backporting-patches.rst \ > + Documentation/internals/contributing/inclusive-language.rst \ > Documentation/internals/contributing/coding-style.rst \ > Documentation/internals/contributing/coding-style-windows.rst \ > Documentation/internals/contributing/documentation-style.rst \ > diff --git a/Documentation/index.rst b/Documentation/index.rst > index 3cdc87c69845..7041384733d8 100644 > --- a/Documentation/index.rst > +++ b/Documentation/index.rst > @@ -43,6 +43,7 @@ Contributing > > - :doc:`internals/contributing/submitting-patches` > - :doc:`internals/contributing/backporting-patches` > + - :doc:`internals/contributing/inclusive-language` > - :doc:`internals/contributing/coding-style` > - :doc:`internals/contributing/coding-style-windows` > > diff --git a/Documentation/internals/contributing/inclusive-language.rst > b/Documentation/internals/contributing/inclusive-language.rst > new file mode 100644 > index 000000000000..e8ee0958b519 > --- /dev/null > +++ b/Documentation/internals/contributing/inclusive-language.rst > @@ -0,0 +1,58 @@ > +.. > + Licensed under the Apache License, Version 2.0 (the "License"); you may > + not use this file except in compliance with the License. You may obtain > + a copy of the License at > + > + http://www.apache.org/licenses/LICENSE-2.0 > + > + Unless required by applicable law or agreed to in writing, software > + distributed under the License is distributed on an "AS IS" BASIS, > WITHOUT > + WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See > the > + License for the specific language governing permissions and limitations > + under the License. > + > + Convention for heading levels in Open vSwitch documentation: > + > + ======= Heading 0 (reserved for the title in a document) > + ------- Heading 1 > + ~~~~~~~ Heading 2 > + +++++++ Heading 3 > + ''''''' Heading 4 > + > + Avoid deeper levels because they do not render well. > + > +================== > +Inclusive Language > +================== > + > +In order to help facilitate an inclusive environment in the Open vSwitch > +community we recognise the role of language in framing our > +communication with each other. It is important that terms that > +may exclude people through racial, cultural or other bias, are avoided > +as they may make people feel excluded. > + > +We recognise that this is subjective, and to some extent is a journey. > +But we also recognise that we cannot begin that journey without taking > +positive action. To this end Open vSwitch is adopting the practice > +of an inclusive word list, which helps to guide the use of language within > +the project. > + > +.. _word list: > + > +Word List > +--------- > + > +The intent of this document is to formally document the acceptance of a > +inclusive word list by Open vSwitch. Accordingly, this document specifies > +use of the use the `Inclusive Naming Word List > +<https://inclusivenaming.org/word-lists/>`__ v1.0 (the word list) for Open > +vSwitch. > + > +The adoption of the word list intended that this act as a guide for > +developers creating patches to the Open vSwitch repository, including both > +source code and documentation. And to aid maintainers in their role of > +shepherding changes into the repository. > + > +Further steps to align usage of language in Open vSwitch, including > +clarification of application of the word list, to new and existing work, > +may follow. > diff --git a/Documentation/internals/contributing/index.rst > b/Documentation/internals/contributing/index.rst > index a46cb046a0f5..91304e60bdc6 100644 > --- a/Documentation/internals/contributing/index.rst > +++ b/Documentation/internals/contributing/index.rst > @@ -35,4 +35,5 @@ The below guides provide information on contributing to > Open vSwitch itself. > coding-style > coding-style-windows > documentation-style > + inclusive-language > libopenvswitch-abi _______________________________________________ dev mailing list [email protected] https://mail.openvswitch.org/mailman/listinfo/ovs-dev
