aboutsummaryrefslogtreecommitdiffstats
path: root/.github/support.md
diff options
context:
space:
mode:
authorLibravatar Titus Wormer <tituswormer@gmail.com>2022-10-12 13:13:02 +0200
committerLibravatar Titus Wormer <tituswormer@gmail.com>2022-10-12 13:13:02 +0200
commitd2a9d952919a05bf17e6bd9d4688a2b9df82fc78 (patch)
treeccc94fb196804e46bb147959186c85f94dbee2cb /.github/support.md
parente0485409fca79af0b47af15ebdba7a3df5c1d3d2 (diff)
downloadmarkdown-rs-d2a9d952919a05bf17e6bd9d4688a2b9df82fc78.tar.gz
markdown-rs-d2a9d952919a05bf17e6bd9d4688a2b9df82fc78.tar.bz2
markdown-rs-d2a9d952919a05bf17e6bd9d4688a2b9df82fc78.zip
Add code of conduct, improve docs
Diffstat (limited to '')
-rw-r--r--.github/support.md46
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