https://github.com/hummusonrails/github-action-gpt-language-check
A GitHub Action that uses ChatGPT to review Markdown files in pull requests for potentially discriminatory language and provides inclusive language suggestions
https://github.com/hummusonrails/github-action-gpt-language-check
actions chatgpt chatgpt-api markdown rust rust-lang
Last synced: about 1 year ago
JSON representation
A GitHub Action that uses ChatGPT to review Markdown files in pull requests for potentially discriminatory language and provides inclusive language suggestions
- Host: GitHub
- URL: https://github.com/hummusonrails/github-action-gpt-language-check
- Owner: hummusonrails
- License: mit
- Created: 2023-04-03T14:54:01.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-04-13T12:15:48.000Z (about 3 years ago)
- Last Synced: 2025-04-14T02:34:22.392Z (about 1 year ago)
- Topics: actions, chatgpt, chatgpt-api, markdown, rust, rust-lang
- Language: Rust
- Homepage:
- Size: 55.3 MB
- Stars: 9
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# GitHub Action: GPT Language Check
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.
## Usage
To use this action in your repository, follow these steps:
1. Set up the `OPENAI_API_KEY` secret in your GitHub repository. You can find more information about setting up secrets in the [GitHub documentation](https://docs.github.com/en/actions/security-guides/encrypted-secrets).
2. Create a new file named `review_markdown.yml` in the `.github/workflows` directory of your repository.
3. Copy the contents of the [sample `review_markdown.yml` file](docs/review_markdown.yml) into the newly created file.
4. 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.
## Contributing
If you would like to contribute to this project, please read the [contributing guidelines](CONTRIBUTING.md) and [code of conduct](CODE_OF_CONDUCT.md).
## License
This project is licensed under the [MIT License](LICENSE).