Skip to content

Commit 8540440

Browse files
committed
update readme
1 parent 5ec6f03 commit 8540440

File tree

1 file changed

+5
-6
lines changed

1 file changed

+5
-6
lines changed

README.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,7 @@ This is a code linter that checks for biased language in a code repository. Curr
66
2. [Developer Instructions](#developer-instructions)
77
3. [Usage Example](#usage-example)
88
4. [Excluding directories and files](#excluding-directories-and-files)
9-
5. [Propose new biased words](#proposing-new-biased-words)
10-
6. [FAQ](#frequently-asked-questions)
9+
5. [FAQ](#frequently-asked-questions)
1110

1211
# Quickstart
1312

@@ -140,10 +139,6 @@ python3 run_json.py --mode=check --path=/user/jdoe/git/myProject
140139

141140
The biased words are listed on a new line in the `word_list.csv` file.
142141

143-
## Proposing new biased words
144-
145-
TBD
146-
147142
## Excluding directories and files
148143

149144
The tool automatically excludes a few common directories you would already want to exclude such as `node_modules`, `__pycache__`, and `.git`.
@@ -166,6 +161,10 @@ If the pipeline detects biased language anywhere in the repository, the `biased_
166161

167162
**A:** You'll need to add your submodule paths in the `.biased_lang_exclude` file. You can find info on how to (exclude files and directories here)[#excluding-directories-and-files]
168163

164+
**Q: How can I search for additional biased terms?**
165+
166+
**A:** You'll have to create a fork of this repo and add your new biased word in `word_list.csv` on a new line. You will also need to update the workflow, `.github/workflows/main.yml`, to publish the Docker image outside of Splunk's organization.
167+
169168
## Learn More
170169

171170
- Bias Free Communication: [Splunk Style Guide](https://docs.splunk.com/Documentation/StyleGuide/current/StyleGuide/Inclusivity)

0 commit comments

Comments
 (0)