There's only one script in the repo. It replaces problematic words in a code base. It specifically looks at markdown files only. There are multiple ways to run this script.

This is a simple docker container that walks through a directory and changes any instance of some problematic words to something more socially acceptable, for instance: slave to follower or master to leader. You can look at the dict we created here and are more than willing to accept PRs to add to the list.

The idea is that this can create a PR for repos via GitHub Actions so we as developers can have bots make sure we start to take these words out of our vocabulary.

There is a containerized version of the script Run these commands from your project root:

docker build -t words-matter .
cd <to source code>
docker run -v `pwd`:/source words-matter

You can of course take the script itself and run it locally, just be aware that you need use bash 4.0 or later and you'll have to push your own changes.

The script can also be run as a GitHub Action and is available in the GitHub Action Marketplace.

For an example run check out this sample output and the corresponding pull request is generated.

To use this function in your repository perform the following steps:

1. Create a GitHub Secret with the key name GH_TOKEN and it's value be a GitHub API key.

2. Create a file in .github/workflows/ and paste the following code:

   on:
     push:
       branches:
         - master
   
   jobs:
     words-matter:
       runs-on: ubuntu-latest
       name: A job to remove problematic words
       steps:
         - name: Checking out our code
           uses: actions/checkout@master
         - name: Remove the problematic words
           uses: jjasghar/actions-words-really-matter@v2.0.1
         - name: Create Pull Request
           uses: peter-evans/create-pull-request@v2
           with:
             token: ${{ secrets.GH_TOKEN }}
             commit-message: Remove problematic words
             title: '[Automated PR] Remove problematic words'
             body: |
               Found a problematic words that can be replaced
   
               [1]: https://github.com/jjasghar/actions-words-really-matter
         - name: Check outputs
           run: |
             echo "Pull Request Number - ${{ env.PULL_REQUEST_NUMBER }}"
             echo "Pull Request Number - ${{ steps.cpr.outputs.pr_number }}"

If you want to re-build this with debug logs, just add this line to the Dockerfile:

ENV DEBUG=true

Re-build it locally and run it.

If you would like to see the detailed LICENCE click here.

• Author: JJ Asghar awesome@ibm.com
• Author: Steve Martinelli stevemar@ca.ibm.com