PyCQA / PyCQA/bandit

Inclusive terminology

Open
#647 2 comments 12 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
8.3k
Forks
835
Avg merge
5d 3h
Merged PRs (30d)
1

Description

Is your feature request related to a problem? Please describe.
In the bandit repository there are currently 27 instances of blacklist, 1 instance of whitelist, and 6 instances of master.

These terms while not intentionally are negative in connotation and should be considered for replacement.

Describe the solution you'd like
I would like an update that results in inclusive terms used in documentation, source code, and in general.
For more context linux kernel merge, email discussion.

Describe alternatives you've considered
Some options to consider:
In place or master (for code branch main):

  • '{primary,main} / {secondary,replica,subordinate}'
  • '{initiator,requester} / {target,responder}'
  • '{controller,host} / {device,worker,proxy}'
  • 'leader / follower'
  • 'director / performer'

In place of black/white list:

  • 'denylist / allowlist'
  • 'blocklist / passlist'

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the repository-wide searches linked in the issue and review each occurrence in documentation and source code to determine its context. Replace the terminology with appropriate inclusive alternatives, then repeat the searches to confirm the listed occurrences have been addressed.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation, tooling
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.