Project Identifier
Hyperledger DCI Working Group
Sponsors
Grace Hartley grace.hartley@consensys.net
??????
Context
The Hyperledger DCI Working Group would like to propose best practices to be adopted by Hyperledger projects around inclusive naming. Hyperledger continuously promotes "all are welcome here" to its community. The DCI Working Group believes one way for Hyperledger to continue to improve is by encouraging inclusive language across all of its projects.
The DCI Working Group is recommending the Technical Steering Committee to approve the following proposal:
Recommendation #1: Every project should update their contributor and/or documentation guidelines to encourage inclusive language. One example from Besu found on the Documentation Style Guide is:
Inclusive Language:
Consider that users who will read the docs are from different background and cultures and that they have different preferences.
Avoid potential offensive terms and, for instance, prefer "allow list and deny list" to "white list and black list".
We believe that we all have a role to play to improve our world, and even if writing inclusive doc might not look like a huge improvement, it's a first step in the right direction.
We suggest to refer to Google inclusive doc writing guide and Microsoft bias free writing guidelines as starting points.
Recommendation #2: The dci-lint tool that Peter Somogyvari put together will be implemented across all Hyperledger repos.
The goal of the dci-lint tool is for projects to be able to automate any language changes. Hyperledger staff is prepared to push this out across the various repos.
Recommendation #3: Include inclusive language as one element of project badging proposal. If projects meet the recommendations, they can gain a badge for inclusive language best practices.
Recommendation #4: Have every Hyperledger project make these specific language changes to their projects. They can use the dci-lint tool provided above.
- master → main
- slave → replicas
- Blacklist → denylist
- Whitelist → allowlist
Reviewed By:
Lindsy Nuon - LGTM