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

Lets use common phrasing #1

Open
repo-mountie bot opened this issue Dec 9, 2021 · 5 comments
Open

Lets use common phrasing #1

repo-mountie bot opened this issue Dec 9, 2021 · 5 comments
Assignees

Comments

@repo-mountie
Copy link

repo-mountie bot commented Dec 9, 2021

TL;DR 🏎️

Teams are encouraged to favour modern inclusive phrasing both in their communication as well as in any source checked into their repositories. You'll find a table at the end of this text with preferred phrasing to socialize with your team.

Words Matter

We're aligning our development community to favour inclusive phrasing for common technical expressions. There is a table below that outlines the phrases that are being retired along with the preferred alternatives.

During your team scrum, technical meetings, documentation, the code you write, etc. use the inclusive phrasing from the table below. That's it - it really is that easy.

For the curious mind, the Public Service Agency (PSA) has published a guide describing how Words Matter in our daily communication. Its an insightful read and a good reminder to be curious and open minded.

What about the master branch?

The word "master" is not inherently bad or non-inclusive. For example people get a masters degree; become a master of their craft; or master a skill. It's generally when the word "master" is used along side the word "slave" that it becomes non-inclusive.

Some teams choose to use the word main for the default branch of a repo as opposed to the more commonly used master branch. While it's not required or recommended, your team is empowered to do what works for them. If you do rename the master branch consider using main so that we have consistency among the repos within our organization.

Preferred Phrasing

Non-Inclusive Inclusive
Whitelist => Allowlist
Blacklist => Denylist
Master / Slave => Leader / Follower; Primary / Standby; etc
Grandfathered => Legacy status
Sanity check => Quick check; Confidence check; etc
Dummy value => Placeholder value; Sample value; etc

Pro Tip 🤓

This list is not comprehensive. If you're aware of other outdated nomenclature please create an issue (PR preferred) with your suggestion.

@repo-mountie
Copy link
Author

repo-mountie bot commented Apr 8, 2022

Hey, its been 120 days since this PR was last updated. I'm sure everyone is busy, however, it would be appreciated if someone from the team puts this issue to bed. Thanks in Advance.

4 similar comments
@repo-mountie
Copy link
Author

repo-mountie bot commented Aug 7, 2022

Hey, its been 120 days since this PR was last updated. I'm sure everyone is busy, however, it would be appreciated if someone from the team puts this issue to bed. Thanks in Advance.

@repo-mountie
Copy link
Author

repo-mountie bot commented Dec 6, 2022

Hey, its been 120 days since this PR was last updated. I'm sure everyone is busy, however, it would be appreciated if someone from the team puts this issue to bed. Thanks in Advance.

@repo-mountie
Copy link
Author

repo-mountie bot commented Apr 6, 2023

Hey, its been 120 days since this PR was last updated. I'm sure everyone is busy, however, it would be appreciated if someone from the team puts this issue to bed. Thanks in Advance.

@repo-mountie
Copy link
Author

repo-mountie bot commented Aug 4, 2023

Hey, its been 120 days since this PR was last updated. I'm sure everyone is busy, however, it would be appreciated if someone from the team puts this issue to bed. Thanks in Advance.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant