Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
160 lines (112 loc) · 5.14 KB

CONTRIBUTING.md

File metadata and controls

160 lines (112 loc) · 5.14 KB
Raw

Contributing to Awesome Accessibility

Thanks for your interest in contributing to this list. I appreciate your help in making accessibility resources more discoverable.

How to Contribute

Suggesting New Resources

If you want to suggest a new resource:

  1. Check for duplicates - Search the list to ensure the resource isn't already included
  2. Verify quality - Ensure the resource is high-quality, accurate, and actively maintained
  3. Open an issue or submit a pull request with:
    • Resource name and URL
    • Brief description (1-2 sentences)
    • Category where it should be added
    • Why it's valuable for the accessibility community

Reporting Issues

If you find broken links, outdated info, or errors:

  1. Open an issue with:
    • Clear description of the problem
    • Location in the list (section and item)
    • Suggested fix (if applicable)

Improving Existing Content

Contributions to improve descriptions, organization, or formatting are also welcome:

  1. Fork the repository
  2. Make your changes following the style guidelines below
  3. Submit a pull request with a clear description

Quality Standards

Resources on this list should:

  • Be relevant to accessibility, assistive technology, or inclusive design
  • Be high-quality and well-maintained
  • Be accessible themselves (practice what they preach)
  • Provide value to developers, designers, or accessibility practitioners
  • Be current and actively updated

Style Guidelines

Formatting

  • Use Markdown formatting
  • Keep descriptions concise (1-2 sentences)
  • Use sentence case for titles
  • Include direct links
  • Maintain alphabetical order within sections where it makes sense

Descriptions

  • Start with what the resource is or does
  • Explain why it's useful
  • Keep it objective
  • Avoid marketing language

Example:

- [Resource Name](https://example.com) - Brief description of what it is and why it's valuable for accessibility work.

Categories

Resources should be placed in appropriate categories:

  • Tools - Software, browser extensions, testing tools
  • Guidelines - Standards, best practices, documentation
  • Learning - Tutorials, courses, educational resources
  • Communities - Forums, groups, organizations
  • Blogs & Articles - Written content and publications
  • Videos & Podcasts - Multimedia educational content
  • Books - Published books on accessibility
  • Assistive Technology - Screen readers, input devices, etc.

If a resource doesn't fit an existing category, suggest a new one in your pull request.

Pull Request Process

  1. Fork the repository
  2. Create a branch with a descriptive name (e.g., add-nvda-resource)
  3. Make your changes following the guidelines above
  4. Test all links to ensure they work
  5. Commit with a clear message (e.g., "Add NVDA screen reader to assistive technology section")
  6. Submit pull request with:
    • Description of what you're adding/changing
    • Why it's valuable
    • Any relevant context

Commit Message Format

Use clear commit messages:

Add [Resource Name] to [Category]
Update [Resource Name] description
Fix broken link for [Resource Name]
Reorganize [Category] section

What I'm Looking For

I especially welcome contributions that:

  • Fill gaps in coverage (underrepresented areas)
  • Add international/multilingual resources
  • Include resources for specific disabilities
  • Highlight emerging accessibility technologies
  • Provide practical, actionable tools and guidance

What Doesn't Belong

Please don't submit:

  • Commercial products without clear accessibility value
  • Resources behind paywalls (unless exceptional)
  • Self-promotion without substantial value
  • Duplicate or very similar resources
  • Outdated or unmaintained projects
  • Off-topic content

Questions?

If you're not sure if a resource fits, or have questions:

  • Open an issue to discuss before submitting
  • Check existing issues and pull requests for similar discussions
  • Review the list to understand the style and quality standards

Code of Conduct

By contributing, you agree to:

  • Be respectful and inclusive
  • Focus on constructive feedback
  • Assume good intentions
  • Help create a welcoming environment

License

By contributing, you agree that your contributions will be licensed under CC0 (public domain).

Thanks for helping make accessibility resources more discoverable.

Luke Steuber

dr.eamer.dev | dr.eamer.dev/datavis | dr.eamer.dev/code

LinkedIn Bluesky CodePen HuggingFace Kaggle