How To Ask A Support Question

Our maintainers, Support Squad and wonderful fellow community members are happy to help you when you need help! Help us help you with the following tips!

Before Asking For Help

  • Check the documentation - Before posting your support question, we encourage you to consult the Astro documentation. We include helpful guides & recipes, as well as complete reference for errors. You can even run the /docs command to search the docs (privately) right in Discord!
  • Search the Discord - If you have a question, it may have already been asked and answered on the Astro Discord. You can use the global search bar in the top right to search the Discord, or use the search bar in the #support channel to search for support threads directly.
  • Search for existing issues - If you already suspect your issue to be a bug, search existing GitHub issues to see if one already exists. Otherwise, you can create a new issue to report your bug. If you want help confirming it's a bug, or creating a reproduction, post to the #support channel in the Astro Discord. If you want to discuss new features/ideas, check out the Astro roadmap and the #feedback-ideas channel in the Discord.

Where to ask

  • #support - We actively monitor the support channel in the Astro Discord server, and this is by far the best place to ask.
  • #support-ai - We have an AI support channel powered by Kapa.ai. Answers here may not always be accurate, but it can be a good starting point when debugging Astro projects. This channel isn't heavily monitored, so if you need further assistance, please follow up in #support.
  • Stack Overflow - We do monitor Stack Overflow for Astro questions, and try our best to answer. Stack Overflow is great, since questions remain public and indexed by search engines, but it doesn't allow for longer conversation in the case of more complex issues.

Where NOT to ask

  • Twitter/X - Some of our community members are active on Twitter/X, but we don't actively monitor for support questions.
  • GitHub - Astro uses GitHub issues to track bugs, not support requests. Please join our Discord server to ask for help.

Providing context

Please avoid using screenshots of code, as they can be hard to read, and we may need to copy your code to create a reproduction.

When asking for support, providing helpful context is important to equip others with what they need to assist you. Some types of context that can assist support squad include:

  • Errors - If your issue includes an error, please include the text and stack trace of that error.
  • Reproductions - If possible, create a minimal reproducible example, which could be a GitHub repository, StackBlitz, CodeSandbox, or Gitpod link. More details in Astro docs Creating a minimal reproduction
  • Code snippets If a reproduction isn't possible, provide code and config files related to the issue you're having. In Discord, code snippets can be created using a pair of 3 backticks (```) surrounding your code. You can add optional syntax highlighting by adding a language after the first line of backticks (Discord doesn't support astro, so tsx is recommended for Astro code). 
    ​```[lang]
​​// my code
​```
  • Environment Information - You can run npx astro info in your project's directory to generate helpful info about your project & OS.
  • Tags - In #support we provide tags for the various topics we receive support questions on. Some community members use these tags to filter for posts on subjects they are best suited to answer. Using the correct tags lets others help you better!

Etiquette

  • Conduct - Astro strives to maintain a healthy and positive community. We expect members to follow our rules (see #rules in Discord) and CODE OF CONDUCT, and treat everyone respectfully.
  • Mentioning/Pinging Individuals - If it doesn't matter WHO answers your question, then don't ask an individual member! This can discourage others, who may be available to help, from responding because they think you're having a conversation. Do not assume that an individual is available, and keep your questions and conversations open and inviting!
  • Mentioning Roles - In general, avoid mentioning any roles. Roles mostly exist for Astro maintainers to send notifications to specific groups of people. A few exceptions exist:
    • @mods - Mention only to report spam content, and other inappropriate behaviour. This role is not for general support.
    • @support-patrol - Mention this role for issues around support. Such as if your post has not received an answer after a day or two, or if you're still stuck, and need further support.
Select a repo