AI WCAG Code Reviewer is a GitHub Action that leverages OpenAI's GPT-4 API to provide intelligent feedback and suggestions following the Web Content Accessibility Guidelines (WCAG) 2.1 covers a wide range of recommendations for making Web content more accessible on your pull requests. This powerful tool helps improve code quality and saves developers time by automating the code review process.

• Reviews pull requests using OpenAI's GPT-4 API.

• Provides intelligent comments and suggestions for improving your code.

• Filters out files that match specified exclude patterns.

• Easy to set up and integrate into your GitHub workflow.

• Provide comments and suggestions ONLY if there is something to improve, otherwise "reviews" should be an empty array.

• Write the comment in GitHub Markdown format with emphasys for WCAG guidelines recomendations.

• Perform a comprehensive accessibility analysis on the source code, focusing on adherence to WCAG guidelines.

• Evaluate the codebase for key aspects such as semantic HTML usage, keyboard navigation, ARIA roles, and contrast ratios.

• Provide detailed feedback on any potential accessibility issues and suggest actionable recommendations for improvement.

• Ensure the analysis covers all relevant WCAG success criteria, emphasizing the importance of creating an inclusive and user-friendly digital experience for individuals with diverse abilities.

1. To use this GitHub Action, you need an OpenAI API key. If you don't have one, sign up for an API key at OpenAI.

2. Add the OpenAI API key as a GitHub Secret in your repository with the name OPENAI_API_KEY. You can find more information about GitHub Secrets here.

3. Create a .github/workflows/main.yml file in your repository and add the following content:

name: AI Code Reviewer

on:
  pull_request:
    types:
      - opened
      - synchronize
permissions: write-all
jobs:
  review:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout Repo
        uses: actions/checkout@v3

      - name: AI Code Reviewer
        uses: richardsonlima/ai-wcag-codereviewer@main
        with:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # The GITHUB_TOKEN is there by default so you just need to keep it like it is and not necessarily need to add it as secret as it will throw an error. [More Details](https://docs.github.com/en/actions/security-guides/automatic-token-authentication#about-the-github_token-secret)
          OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
          OPENAI_API_MODEL: "gpt-4" # Optional: defaults to "gpt-4"
          exclude: "**/*.json, **/*.md" # Optional: exclude patterns separated by commas

4. Customize the exclude input if you want to ignore certain file patterns from being reviewed.

5. Commit the changes to your repository, and AI Code Reviewer will start working on your future pull requests.

The AI Code Reviewer GitHub Action retrieves the pull request diff, filters out excluded files, and sends code chunks to the OpenAI API. It then generates review comments based on the AI's response and adds them to the pull request.

Contributions are welcome! Please feel free to submit issues or pull requests to improve the AI Code Reviewer GitHub Action.

Let the maintainer generate the final package (yarn build & yarn package).

This project is licensed under the MIT License. See the LICENSE file for more information.