Skip to content
Accessible Astro Documentation

Issues

Reporting issues

Before submitting a new issue, please:

  1. Search existing issues to avoid duplicates
  2. Check you’re using the latest version
  3. Read our documentation thoroughly

Bug reports

When reporting a bug, include:

## 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.


## Actual behavior
A description of what actually happened.


## 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

When requesting a feature, include:

## Problem
Describe the problem you're trying to solve.


## Proposed solution
Describe your proposed solution.


## Alternatives considered
List any alternatives you've considered.


## Additional context
Add any other context about the feature request.

Issue labels

We use labels to categorize issues:

  • bug: Something isn’t working
  • feature: New feature request
  • documentation: Documentation improvements
  • good first issue: Good for newcomers
  • help wanted: Extra attention needed
  • priority: Urgent fixes needed

Issue lifecycle

  1. New: Issue is submitted
  2. Triage: Maintainers review and label
  3. In progress: Work has started
  4. Review: Changes are being reviewed
  5. Resolved: Issue is closed

Best practices

Do

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

Don’t

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

Security issues

For security vulnerabilities, please:

  1. Don’t create a public issue
  2. Email security@yourdomain.com
  3. Follow responsible disclosure

Getting help

Need help before creating an issue?

Issue templates

We provide templates for:

  • Bug reports
  • Feature requests
  • Documentation improvements
  • General questions

Choose the appropriate template when creating a new issue to ensure you provide all necessary information.