Skip to content
Accessible Astro Documentation

Issues

Reporting issues

Section titled “Reporting issues”

We value your feedback and bug reports! They help us improve our components and themes. Before submitting a new issue, please follow these steps to ensure efficient problem-solving.

  1. Check existing issues

    • Search open and closed issues
    • Look for similar problems
    • Check recent releases

  2. Gather information

    • Component or theme version
    • Astro version
    • Browser and OS details
    • Error messages
    • Screenshots or recordings

  3. Create minimal reproduction

    • Isolate the problem
    • Remove unnecessary code
    • Use CodeSandbox if possible

Issue templates

Section titled “Issue templates”

We provide several issue templates to help you provide the right information:

Bug reports

Section titled “Bug reports”
## Description
A clear description of what the bug is.


## Steps to reproduce
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error


## Expected behavior
A description of what you expected to happen.


## Environment
- OS: [e.g., Windows 11]
- Browser: [e.g., Chrome 120]
- Component version: [e.g., 2.1.0]
- Astro version: [e.g., 4.0.3]

Feature requests

Section titled “Feature requests”
## Problem
Describe the problem you're trying to solve.


## Proposed solution
Describe your proposed solution.


## Additional context
Add any other context or screenshots.

Best practices

Section titled “Best practices”

Do

Section titled “Do”
  • Be specific and clear
  • Include minimal reproduction
  • Follow the issue template
  • Be respectful and patient
  • Update if more info is found

Don’t

Section titled “Don’t”
  • Create duplicate issues
  • Combine multiple problems
  • Leave out crucial details
  • Demand immediate fixes
  • Comment “+1” (use reactions)

Issue labels

Section titled “Issue labels”

We use labels to help organize and prioritize issues:

  • bug - Something isn’t working
  • feature - New feature request
  • documentation - Documentation improvements
  • good first issue - Good for newcomers
  • help wanted - Extra attention needed
  • accessibility - Accessibility-related issues
  • theme - Theme-specific issues
  • component - Component-specific issues

Issue lifecycle

Section titled “Issue lifecycle”

  1. Submitted

    • Issue is created
    • Awaiting initial review

  2. Triaged

    • Labels are added
    • Priority is assigned
    • Maintainer is assigned

  3. In Progress

    • Work has started
    • Branch is created
    • Updates are posted

  4. Review

    • Changes are reviewed
    • Testing is performed
    • Feedback is provided

  5. Resolved

    • Issue is closed
    • Changes are merged
    • Documentation is updated

Security issues

Section titled “Security issues”

For security vulnerabilities:

Getting help

Section titled “Getting help”

Need help before creating an issue? We’re here to help!