This GitHub action reviews markdown files in your pull requests for potentially discriminatory language, including but not limited to ableism, ageism, racism, antisemitism, Islamophobia, and similar issues. It uses the OpenAI GPT-3.5 language model to detect discriminatory language and provides suggestions for alternative language.
To use this action in your repository, follow these steps:
-
Set up the
OPENAI_API_KEY
secret in your GitHub repository. You can find more information about setting up secrets in the GitHub documentation. -
Create a new file named
review_markdown.yml
in the.github/workflows
directory of your repository. -
Copy the contents of the sample
review_markdown.yml
file into the newly created file. -
Commit and push your changes to the repository.
When a pull request is created or updated with changes to markdown files, this action will review them for potentially discriminatory language and add a comment to the pull request with suggestions for alternative language if any issues are found.
If you would like to contribute to this project, please read the contributing guidelines and code of conduct.
This project is licensed under the MIT License.