crashkeys.dev
Markdown parser fork with extended syntax for personal use.
1# Support
2
3> 👉 **Important**: this project has a [code of conduct][coc].
4> By interacting with this repository and community you agree to abide by its
5> terms.
6
7This article explains how and where to get help.
8Please read through the following guidelines.
9
10## Asking quality questions
11
12Questions can go to [GitHub discussions][chat].
13
14Help us help you!
15Spend time framing questions and add links and resources.
16Spending the extra time up front helps save everyone time in the long run.
17Here are some tips:
18
19* see [*How do I ask a good question* by `StackOverflow`][how-to-ask] for a
20 good guide
21* [talk to a duck][rubberduck]!
22* don’t fall for the [XY problem][xy]
23* search to find out if a similar question has been asked
24* try to define what you need help with:
25 * is there something in particular you want to do?
26 * what problem are you encountering and what steps have you taken to try
27 and fix it?
28 * is there a concept you don’t understand?
29* provide sample code, if possible
30* screenshots can help, but if there’s important text such as code or error
31 messages in them, please also provide those as text
32* the more time you put into asking your question, the better we can help you
33
34## Contributions
35
36See [`contribute.md`][contribute] on how to contribute.
37
38## License
39
40[CC-BY-4.0][license] © [Titus Wormer][author]
41
42<!-- Definitions -->
43
44[license]: https://creativecommons.org/licenses/by/4.0/
45
46[author]: https://wooorm.com
47
48[rubberduck]: https://rubberduckdebugging.com
49
50[xy]: https://meta.stackexchange.com/questions/66377/what-is-the-xy-problem/66378#66378
51
52[chat]: https://github.com/wooorm/markdown-rs/discussions
53
54[contribute]: contribute.md
55
56[coc]: code-of-conduct.md
57
58[how-to-ask]: https://stackoverflow.com/help/how-to-ask