Skip to content
Accessible Astro Documentation

How to contribute

Ways to contribute

Contributing to open source can seem daunting at first, but there are many ways to help! Whether you’re a developer, designer, writer, or just someone who uses our components and themes, your contributions are valuable to making the web more accessible.

  1. Code contributions

    • Fix bugs in components or themes
    • Add new features or components
    • Improve documentation
    • Write tests
    • Enhance accessibility
    • Improve performance
    • Create new theme variations

  2. Documentation

    • Fix typos
    • Add examples and use cases
    • Clarify explanations
    • Translate content
    • Add theme customization guides
    • Improve code comments
    • Add component demos

  3. Issue reporting

    • Report bugs in components
    • Report theme compatibility issues
    • Suggest new features or components
    • Share theme customizations
    • Report accessibility issues
    • Test in different browsers
    • Test theme responsiveness

  4. Community support

    • Answer questions
    • Share knowledge
    • Review pull requests
    • Help others with theme customization
    • Share your theme variations
    • Write blog posts or tutorials
    • Create video content

Getting started

Ready to contribute? Great! Follow these steps to set up your development environment and make your first contribution. Don’t worry if you’re new to this – we’re here to help you succeed.

  1. Fork the repository you want to contribute to:

    Components:

    Themes:

    Documentation:

  2. Clone your fork:

    Terminal window
    git clone https://github.com/YOUR-USERNAME/REPO-NAME.git

  3. Create a new branch:

    Terminal window
    git checkout -b fix/issue-description

  4. Install dependencies:

    Terminal window
    npm install

  5. Start the development server:

    Terminal window
    npm run dev

Making changes

Once your environment is set up, you can start making changes. We have some guidelines to ensure consistency and quality across all contributions.

  1. Follow our development guidelines
  2. Make your changes
  3. Add or update tests if needed
  4. Update documentation if needed
  5. Follow our style guide
  6. Run tests: npm run test (components only) Yet to be implemented
  7. Check types: npm run typecheck Yet to be implemented
  8. For themes: test across different screen sizes and browsers

Submitting changes

Ready to submit your changes? We use Pull Requests to review and merge new contributions. This helps us maintain quality and provides a place for discussion.

  1. Commit your changes:

    Terminal window
    git add .
    git commit -m "fix: description of your changes"

  2. Push to your fork:

    Terminal window
    git push origin fix/issue-description

  3. Open a pull request:

    • Use a clear title
    • Reference any related issues
    • Describe your changes
    • Add screenshots (especially for theme changes)
    • Add before/after comparisons if relevant
    • Fill out the PR template

Code review process

After submitting your PR, here’s what happens next. Don’t worry if changes are requested – it’s a normal part of the process and helps us maintain quality.

  1. Maintainers will review your PR
  2. Automated tests will run (for components)
  3. Changes might be requested
  4. Visual review for theme changes
  5. Once approved, your PR will be merged

Need help?

We’re a friendly community and always happy to help! If you’re stuck or have questions, here are several ways to get assistance: