path: root/.github/support.md



# Support

This article explains how and where to get help.
Please read through the following guidelines.

## Asking quality questions

Questions can go to [GitHub discussions][chat].

Help us help you!
Spend time framing questions and add links and resources.
Spending the extra time up front helps save everyone time in the long run.
Here are some tips:

- see [this article on _How do I ask a good question_][how-to-ask] for help
- [talk to a duck][rubberduck]!
- don’t fall for the [XY problem][xy]
- search to find out if a similar question has been asked
- try to define what you need help with:
  - is there something in particular you want to do?
  - what problem are you encountering and what steps have you taken to try
    and fix it?
  - is there a concept you don’t understand?
- provide sample code, if possible
- screenshots can help, but if there’s important text such as code or error
  messages in them, please also provide those as text
- the more time you put into asking your question, the better we can help you

## Contributions

See [`contributing.md`][contributing] on how to contribute.

## License

[CC-BY-4.0][license] © [Titus Wormer][author]

<!-- Definitions -->

[license]: https://creativecommons.org/licenses/by/4.0/
[author]: https://wooorm.com
[coc]: https://github.com/remarkjs/.github/blob/main/code-of-conduct.md
[rubberduck]: https://rubberduckdebugging.com
[xy]: https://meta.stackexchange.com/questions/66377/what-is-the-xy-problem/66378#66378
[chat]: https://github.com/remarkjs/remark/discussions
[contributing]: contributing.md
[how-to-ask]: https://stackoverflow.com/help/how-to-ask
# Support

This article explains how and where to get help.
Please read through the following guidelines.

## Asking quality questions

Questions can go to [GitHub discussions][chat].

Help us help you!
Spend time framing questions and add links and resources.
Spending the extra time up front helps save everyone time in the long run.
Here are some tips:

- see [this article on _How do I ask a good question_][how-to-ask] for help
- [talk to a duck][rubberduck]!
- don’t fall for the [XY problem][xy]
- search to find out if a similar question has been asked
- try to define what you need help with:
  - is there something in particular you want to do?
  - what problem are you encountering and what steps have you taken to try
    and fix it?
  - is there a concept you don’t understand?
- provide sample code, if possible
- screenshots can help, but if there’s important text such as code or error
  messages in them, please also provide those as text
- the more time you put into asking your question, the better we can help you

## Contributions

See [`contributing.md`][contributing] on how to contribute.

## License

[CC-BY-4.0][license] © [Titus Wormer][author]

<!-- Definitions -->

[license]: https://creativecommons.org/licenses/by/4.0/
[author]: https://wooorm.com
[coc]: https://github.com/remarkjs/.github/blob/main/code-of-conduct.md
[rubberduck]: https://rubberduckdebugging.com
[xy]: https://meta.stackexchange.com/questions/66377/what-is-the-xy-problem/66378#66378
[chat]: https://github.com/remarkjs/remark/discussions
[contributing]: contributing.md
[how-to-ask]: https://stackoverflow.com/help/how-to-ask