Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Inclusive language #238

Merged
merged 41 commits into from
Jan 26, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
41 commits
Select commit Hold shift + click to select a range
1746860
Create inclusive-language.md
andyblundell Jan 10, 2022
37b4363
Update inclusive-language.md
andyblundell Jan 10, 2022
751b090
Update inclusive-language.md
andyblundell Jan 10, 2022
eeba91c
Update inclusive-language.md
andyblundell Jan 10, 2022
6e16094
Update inclusive-language.md
andyblundell Jan 10, 2022
f1aa1fd
Update inclusive-language.md
andyblundell Jan 10, 2022
ab466e4
Update inclusive-language.md
andyblundell Jan 10, 2022
6a088e7
Update inclusive-language.md
andyblundell Jan 10, 2022
b90b13a
Update inclusive-language.md
andyblundell Jan 10, 2022
3d81131
Update inclusive-language.md
andyblundell Jan 10, 2022
779980b
Update inclusive-language.md
andyblundell Jan 10, 2022
6d98f61
Update inclusive-language.md
andyblundell Jan 10, 2022
6b9fc04
Update inclusive-language.md
andyblundell Jan 10, 2022
c916ae9
Update inclusive-language.md
andyblundell Jan 10, 2022
8b0a3ce
Update inclusive-language.md
andyblundell Jan 10, 2022
a040ec9
Update inclusive-language.md
andyblundell Jan 10, 2022
fbf142d
Update inclusive-language.md
andyblundell Jan 10, 2022
4abe5f5
Update inclusive-language.md
andyblundell Jan 10, 2022
4e8ca55
Update inclusive-language.md
andyblundell Jan 10, 2022
00c43c1
Update inclusive-language.md
andyblundell Jan 10, 2022
4d62855
Update inclusive-language.md
andyblundell Jan 10, 2022
0533035
Update inclusive-language.md
RickyHarding Jan 10, 2022
ab3ce41
Update inclusive-language.md
RickyHarding Jan 10, 2022
ab29110
Update inclusive-language.md
andyblundell Jan 10, 2022
5acc45d
Update inclusive-language.md
andyblundell Jan 10, 2022
58b0dd7
Update inclusive-language.md
andyblundell Jan 10, 2022
dc5e75f
Update inclusive-language.md
andyblundell Jan 10, 2022
d8e8822
Update inclusive-language.md
andyblundell Jan 10, 2022
5117dca
Update inclusive-language.md
RickyHarding Jan 10, 2022
badcd2a
Update inclusive-language.md
RickyHarding Jan 10, 2022
93dd7a5
Update principles.md
andyblundell Jan 10, 2022
04eb0a6
Update principles.md
andyblundell Jan 10, 2022
8daa030
Update principles.md
andyblundell Jan 10, 2022
584350c
Update CONTRIBUTING.md
andyblundell Jan 10, 2022
291cb55
Update CONTRIBUTING.md
andyblundell Jan 10, 2022
af19ec7
Update principles.md
andyblundell Jan 10, 2022
cf22d91
Update inclusive-language.md
andyblundell Jan 10, 2022
0a207d3
Update inclusive-language.md
andyblundell Jan 10, 2022
b192c7b
Update inclusive-language.md
andyblundell Jan 10, 2022
358d688
Update inclusive-language.md
andyblundell Jan 15, 2022
a66f97b
Update inclusive-language.md
andyblundell Jan 15, 2022
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,3 +21,4 @@ When committing your changes, please reference the issue they're resolving, so i
* The framework is open to the world. This has a few implications:
* Nothing in it should be confidential, private to NHSD or include any personal data.
* All links in framework pages should be public.
* Use [inclusive language](../inclusive-language.md): avoid terms which cause hurt and offence, including if they have historically been considered industry-standard terms.
45 changes: 45 additions & 0 deletions inclusive-language.md
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.
andyblundell marked this conversation as resolved.
Show resolved Hide resolved

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 |

andyblundell marked this conversation as resolved.
Show resolved Hide resolved
andyblundell marked this conversation as resolved.
Show resolved Hide resolved
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/)
andyblundell marked this conversation as resolved.
Show resolved Hide resolved
* [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)

2 changes: 2 additions & 0 deletions principles.md
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,8 @@ We need to figure out how to deliver software as fast as possible. This reduces

**No blame.** When things go wrong, treat it as a learning opportunity for the team and organisation. Use blameless post mortems and Five Whys.

**[Use inclusive language.](inclusive-language.md)** Avoid terms which cause hurt and offence, including if they have historically been considered industry-standard terms.

## 7. Optimise the whole

**Visualise the work.** Map the value stream with a Kanban board, identify bottlenecks.
Expand Down