Lets use common phrasing
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 25/100
- Issue type
- Documentation
- Clarity
- Needs clarification
- Activity status
- Stale
- Domain
- documentation
Research direction
The issue provides a preferred-phrasing table but names no file, test, or entry point. Search the repository for the listed terms, then confirm the intended scope with maintainers; done is not defined by the issue.
Written by the indexing model from the issue text.
Description
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.
- Dominant language
- TypeScript
- Stars
- 0
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from bcgov/FWA_Visualization
-
Difficulty 1/5 Under an hour Newbie friendliness 55/100
bcgov/FWA_Visualization#4 · 1 comment ·
-
Add missing topicsOpen
Difficulty 1/5 Under an hour Newbie friendliness 45/100
bcgov/FWA_Visualization#2 · 1 comment ·
All issues in bcgov/FWA_Visualization
Similar issues
-
check:passed streams:add
Difficulty 1/5 1-3 hours Newbie friendliness 72/100
Maintainers usually reply within 2 days
-
beta technical-medium ui
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
walletbeat/walletbeat#1625 ·
Maintainers usually reply within 1 day
-
Good First Issue hacktoberfest
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
hiero-ledger/hiero-sdk-js#4489 ·
Maintainers usually reply within 1 day
-
[Bug] The clients language filter cannot select the rows the page labels as unknownPossibly taken A pull request linked to this issue is open or already merged. Open
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
apache/rocketmq-dashboard#6103 ·
Maintainers usually reply within 4 days
-
Bug
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
payloadcms/payload#18652 ·
Maintainers usually reply within 1 day