https://github.com/puntorigen/a11y_checker

Github Action for checking PRs against WCAG accessibility guidelines and provide suggested fixes as comments, using agents
https://github.com/puntorigen/a11y_checker

Last synced: 3 months ago
JSON representation

Github Action for checking PRs against WCAG accessibility guidelines and provide suggested fixes as comments, using agents

• Host: GitHub
• URL: https://github.com/puntorigen/a11y_checker
• Owner: puntorigen
• License: mit
• Created: 2025-01-03T11:32:16.000Z (5 months ago)
• Default Branch: main
• Last Pushed: 2025-01-11T12:48:58.000Z (5 months ago)
• Last Synced: 2025-01-18T13:23:54.840Z (5 months ago)
• Language: Python
• Homepage:
• Size: 129 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# A11y PR Checker

A GitHub Action for checking pull requests (PRs) against WCAG accessibility guidelines and provide suggested fixes as comments. It uses a team of experts to assess and validate incremental accesibility issues on your repositories.

## Requirements

- OpenAI API Key

## Sample Usage

1. Create a GitHub workflow template in your repository like the following:

    ```yml

    name: PR A11Y BOT

    on:

      pull_request:

        types: [opened, synchronize, reopened]

    # This is needed for the action to be able to post comments

    permissions:

      issues: write

      pull-requests: write

      contents: read

    jobs:

      test-action:

        runs-on: ubuntu-latest

        steps:

          - name: Checkout code

            uses: actions/checkout@v2

          - name: Run PR BOT

            uses: puntorigen/[email protected]

            with:

              github-token: ${{ secrets.GITHUB_TOKEN }}

              openai-api-key: ${{ secrets.OPENAI_API_KEY }}

    ```

Now, every time you create a PR in your repository, the action will check if it complies with the WCAG accessibility guidelines. It will then post a comment with the results, indicating whether the PR is successful or not. If the PR has breaking guidelines, an explanation will be provided below the non-compliant files alongside a suggested fix.

#### This project is based on the [pr-rules](github.com/puntorigen/pr-rules) project.