Open MaureenHelm opened 1 year ago
Process WG:
Standard Linux spellchecker have apparently not been mentioned yet:
@kartben This issue covers checking inclusive language for new code. But we need a process to address breaking changes for violations already in the tree. @nashif - We need to open issues for each area that need updates. @jfischer-no - there is a sample pulling in a 3rd party tool that adds in "slave" as part of the documentation. Tool test modbus Zephyr. How should we handle this? @kartben - The documentation should note Zephyr makes a best effort to use inclusive language and ask contributors to open issues that aren't compliant. We probably can't get rid of all instances, so a disclaimer would be helpful. @kartben - Will run the Microsoft tool to see what the status of inclusive terms in the tree. "blackbox" is a term flagged by the MS tool that should probably be allowed.
Introduction
An inclusive language coding guideline was agreed upon by the TSC on 26 Aug 2020 and added to the documentation in #30508. Add an automatic compliance check to verify that PRs don't introduce new usage of offensive terms.
https://docs.zephyrproject.org/latest/contribute/coding_guidelines/index.html#rule-a-2-inclusive-language
Problem description
Violations of the inclusive language coding guideline currently are caught by manual inspection only and therefore are easily missed.
Example in https://github.com/zephyrproject-rtos/zephyr/pull/56800#discussion_r1177953787
Proposed change
Add a compliance check to automate checking PRs for violations of the inclusive language coding guideline.
Concerns and Unresolved Questions
How to handle PRs that modify existing usages of offensive terms?