-
Notifications
You must be signed in to change notification settings - Fork 35
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Co-authored-by: RickyHarding <[email protected]> Co-authored-by: Harry Coulter <[email protected]>
- Loading branch information
1 parent
4850a25
commit 1a81e1b
Showing
3 changed files
with
48 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
# Inclusive language | ||
|
||
## Context | ||
|
||
* This is part of a broader [quality framework](README.md) | ||
* This guidance has been co-authored with the NHS Digital [EMBRACE network](https://digital.nhs.uk/about-nhs-digital/corporate-information-and-documents/staff-networks#ethnic-minorities-broadening-racial-awareness-and-cultural-exchange-embrace-) and the [Lesbian, Gay, Bisexual, Transgender, Queer and Allies (LGBTQ+) network](https://digital.nhs.uk/about-nhs-digital/corporate-information-and-documents/staff-networks#lesbian-gay-bisexual-transgender-queer-and-allies-lgbtq-) | ||
|
||
## Background | ||
|
||
The language and terminology we use is important, and there are certain industry-standard terms which cause hurt and offence. Furthermore, the 'old' standard terms use arbitrary language, for example replacing White / Black with terms such as Allow / Deny or Permit / Block removes ambiguity and delivers a better experience for all users. | ||
|
||
In line with organisations such as the [Home Office](https://hodigital.blog.gov.uk/2020/07/23/not-a-black-and-white-issue-using-racially-neutral-terms-in-technology/) and the [National Cyber Security Centre](https://www.ncsc.gov.uk/blog-post/terminology-its-not-black-and-white), we recognise that historically we have used these terms, and we will strive to avoid using these terms in the future. | ||
|
||
## Details | ||
|
||
| Context | Term we will avoid | Terms we will use instead (suggested) | | ||
| :------------------------------ | :-------------------- | :------------------------------------ | | ||
| Infrastructure (e.g. databases) | Master | Primary | | ||
| Infrastructure (e.g. databases) | Slave | Replica / Secondary / Worker / Agent | | ||
| Source control | Master | Main (see [below](#renaming-the-master-branch-in-github) for GitHub notes) | | ||
| Security / permissions | Whitelist | Allowlist / Permitlist | | ||
| Security / permissions | Blacklist | Denylist / Blocklist | | ||
|
||
Note: this is not intended to be an exhaustive list, and further suggestions are [very welcome](.github/CONTRIBUTING.md). | ||
|
||
## Renaming the master branch in GitHub | ||
|
||
GitHub have published [guidance](https://github.com/github/renaming) around renaming the master branch. It is worth noting that GitHub retains a history of the names of the parent branch so that existing links to your repository aren't broken - for example the parent branch in this repository has been renamed from master to main, but old links to the master address still work ([https://github.com/NHSDigital/software-engineering-quality-framework/blob/master/README.md](https://github.com/NHSDigital/software-engineering-quality-framework/blob/master/README.md)) and are automatically redirected to the main branch. | ||
|
||
In addition to the guidance from GitHub, developers will need to update local copies of a repository if the "master" branch is renamed - this example is for a renaming from master to main: | ||
|
||
``` | ||
git branch -m master main | ||
git fetch origin | ||
git branch -u origin/main main | ||
git remote set-head origin -a | ||
``` | ||
## Further reading | ||
|
||
* [inclusivenaming.org](https://inclusivenaming.org/word-lists/overview/) | ||
* [Internet Engineering Task Force](https://datatracker.ietf.org/doc/draft-knodel-terminology/) | ||
* [Python](https://bugs.python.org/issue34605) | ||
* [GitHub](https://github.com/github/renaming) | ||
* [NCSC](https://www.ncsc.gov.uk/blog-post/terminology-its-not-black-and-white) | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters