diff options
Diffstat (limited to '.github/support.md')
| -rw-r--r-- | .github/support.md | 46 |
1 files changed, 29 insertions, 17 deletions
diff --git a/.github/support.md b/.github/support.md index 7fd182d..afc8aaf 100644 --- a/.github/support.md +++ b/.github/support.md @@ -1,5 +1,9 @@ # Support +> 👉 **Important**: this project has a [code of conduct][coc]. +> By interacting with this repository and community you agree to abide by its +> terms. + This article explains how and where to get help. Please read through the following guidelines. @@ -12,23 +16,24 @@ 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 +* see [*How do I ask a good question* by `StackOverflow`][how-to-ask] for a + good guide +* [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. +See [`contribute.md`][contribute] on how to contribute. ## License @@ -37,10 +42,17 @@ See [`contributing.md`][contributing] on how to contribute. <!-- 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 + +[chat]: https://github.com/wooorm/micromark-rs/discussions + +[contribute]: contribute.md + +[coc]: code-of-conduct.md + [how-to-ask]: https://stackoverflow.com/help/how-to-ask |