|
1 | 1 | # Support |
2 | 2 |
|
3 | | -> This project has a [code of conduct][coc]. |
4 | | -> By interacting with this repository, |
5 | | -> organization, |
6 | | -> or community you agree to abide by its terms. |
7 | | -
|
8 | 3 | Hi! |
9 | 4 | 👋 |
10 | | -We’re excited that you’re using **unist** (**syntax-tree**) and we’d love to |
11 | | -help. |
12 | | -To help us help you, |
13 | | -please read through the following guidelines. |
14 | | - |
15 | | -Please understand that people involved with this project often do so for fun, |
16 | | -next to their day job; |
17 | | -you are not entitled to free customer service. |
| 5 | +Take a moment to read the following guidelines. |
| 6 | +Thanks for using our work! |
18 | 7 |
|
19 | 8 | ## Contents |
20 | 9 |
|
21 | | -* [Questions](#questions) |
22 | | - * [Asking quality questions](#asking-quality-questions) |
| 10 | +* [Expectations](#expectations) |
23 | 11 | * [Contributions](#contributions) |
| 12 | +* [Where to ask questions](#where-to-ask-questions) |
| 13 | +* [How to ask questions](#how-to-ask-questions) |
24 | 14 | * [License](#license) |
25 | 15 |
|
26 | | -## Questions |
27 | | - |
28 | | -Please chat and ask questions on [Discussions][chat]! |
29 | | -Jump in there and lurk, |
30 | | -talk to us, |
31 | | -and help others. |
32 | | - |
33 | | -* **[unified](https://github.com/unifiedjs/unified/discussions)** |
34 | | - — topics relating to **[unified][]** in general |
35 | | -* **[remark](https://github.com/remarkjs/remark/discussions)** |
36 | | - — topics relating to the [remark][] ecosystem, |
37 | | - markdown, |
38 | | - and **[mdast][]** |
39 | | -* **[rehype](https://github.com/rehypejs/rehype/discussions)** |
40 | | - — topics relating to the **[rehype][]** ecosystem, |
41 | | - HTML, |
42 | | - and **[hast][]** |
43 | | -* **[retext](https://github.com/retextjs/retext/discussions)** |
44 | | - — topics relating to the **[retext][]** ecosystem, |
45 | | - natural language, |
46 | | - and **[nlcst][]** |
47 | | -* **[MDX](https://github.com/mdx-js/mdx/discussions)** |
48 | | - — topics relating to **[MDX][]** |
49 | | -* **[micromark](https://github.com/micromark/micromark/discussions)** |
50 | | - — topics relating to the future of markdown in unified! |
51 | | -* **[vfile](https://github.com/vfile/vfile/discussions)** |
52 | | - — topics relating to **[vfile][]**: virtual files |
53 | | -* **[syntax-tree](https://github.com/syntax-tree/unist/discussions)** |
54 | | - — topics relating to **[syntax-tree][]** and **[unist][]** |
55 | | - |
56 | | -### Asking quality questions |
57 | | - |
58 | | -Help us help you! |
59 | | - |
60 | | -Spending time framing a question and adding support links or resources makes it |
61 | | -much easier for us to help. |
62 | | -It’s easy to fall into the trap of asking something too specific when you’re |
63 | | -close to a problem. |
64 | | -Then, |
65 | | -those trying to help you out have to spend a lot of time asking additional |
66 | | -questions to understand what you are hoping to achieve. |
67 | | - |
68 | | -Spending the extra time up front can help save everyone time in the long run. |
69 | | - |
70 | | -* try to define what you need help with: |
71 | | - * is there something in particular you want to do? |
72 | | - * what problem are you encountering and what steps have you taken to try |
73 | | - and fix it? |
74 | | - * is there a concept you’re not understanding? |
75 | | -* learn about the [rubber duck debugging method][rubberduck] |
76 | | -* avoid falling for the [XY problem][xy] |
77 | | -* search on GitHub to see if a similar question has been asked |
78 | | -* if possible, |
79 | | - provide sample code, |
80 | | - a [CodeSandbox][], |
81 | | - or a video |
82 | | -* the more time you put into asking your question, |
83 | | - the better we can help you |
84 | | - |
85 | | -## Contributions |
86 | | - |
87 | | -See [`contributing.md`][contributing] on how to contribute. |
88 | | - |
89 | | -## License |
90 | | - |
91 | | -This document has the following license: |
92 | | -[CC-BY-4.0][license] © [Titus Wormer][author] |
93 | | - |
94 | | -[license]: https://creativecommons.org/licenses/by/4.0/ |
| 16 | +## Expectations |
95 | 17 |
|
96 | | -[author]: http://wooorm.com |
| 18 | +This community has a [code of conduct][file-code-of-conduct]. |
| 19 | +You must follow it when interacting with the community. |
97 | 20 |
|
98 | | -[coc]: https://github.com/syntax-tree/.github/blob/main/code-of-conduct.md |
| 21 | +Be respectful and considerate when asking for things. |
| 22 | +You are not entitled to free customer service. |
99 | 23 |
|
100 | | -[vfile]: https://github.com/vfile |
| 24 | +Be friendly! |
| 25 | +Be excellent to each other. |
101 | 26 |
|
102 | | -[syntax-tree]: https://github.com/syntax-tree |
103 | | - |
104 | | -[unist]: https://github.com/syntax-tree/unist |
| 27 | +## Contributions |
105 | 28 |
|
106 | | -[mdast]: https://github.com/syntax-tree/mdast |
| 29 | +See [`contributing.md`][file-contributing] on how to contribute. |
| 30 | + |
| 31 | +## Where to ask questions |
| 32 | + |
| 33 | +Each organization has a discussion forum: |
| 34 | + |
| 35 | +* [`mdx`](https://github.com/orgs/mdx-js/discussions) |
| 36 | + — markdown for the component era |
| 37 | +* [`micromark`](https://github.com/orgs/micromark/discussions) |
| 38 | + — underlying markdown parser |
| 39 | +* [`rehype`](https://github.com/orgs/rehypejs/discussions) |
| 40 | + — HTML ecosystem |
| 41 | +* [`remark`](https://github.com/orgs/remarkjs/discussions) |
| 42 | + — markdown ecosystem |
| 43 | +* [`retext`](https://github.com/orgs/retextjs/discussions) |
| 44 | + — natural language ecosystem |
| 45 | +* [`syntax-tree`](https://github.com/orgs/syntax-tree/discussions) |
| 46 | + — ASTs: |
| 47 | + estree, |
| 48 | + hast, |
| 49 | + mdast, |
| 50 | + nlcst, |
| 51 | + unist, |
| 52 | + xast |
| 53 | +* [`unified`](https://github.com/orgs/unifiedjs/discussions) |
| 54 | + — core of the ecosystem |
| 55 | +* [`vfile`](https://github.com/orgs/vfile/discussions) |
| 56 | + — virtual file format |
| 57 | + |
| 58 | +## How to ask questions |
| 59 | + |
| 60 | +* help us help you! |
| 61 | + spend time framing questions |
| 62 | +* show the code, |
| 63 | + show what you tried |
| 64 | +* search [discussions][github-search-discussions] and |
| 65 | + [issues][github-search-issues] before opening something, |
| 66 | + include links to what you find |
| 67 | +* make your question concrete, |
| 68 | + zoom in; |
| 69 | + explain what the actual problem is |
| 70 | +* when you ask something specific, |
| 71 | + zoom out; |
| 72 | + explain the context of your question |
| 73 | +* anticipate a follow up question of “Why?” and answer it already |
| 74 | +* anticipate another follow up question of “Why?” and answer it already |
| 75 | +* learn about the [rubber duck debugging method][rubberduckdebugging], |
| 76 | + it really helps |
| 77 | +* avoid falling for the [XY problem][stackexchange-xy-problem] |
| 78 | +* provide sample code: |
| 79 | + a markdown code block, |
| 80 | + [CodeSandbox][], |
| 81 | + [StackBlitz][], |
| 82 | + video |
107 | 83 |
|
108 | | -[nlcst]: https://github.com/syntax-tree/nlcst |
| 84 | +## License |
109 | 85 |
|
110 | | -[hast]: https://github.com/syntax-tree/hast |
| 86 | +This document has the following license: |
| 87 | +[CC-BY-4.0][creativecommons-by] © [Titus Wormer][wooorm] |
111 | 88 |
|
112 | | -[unified]: https://github.com/unifiedjs/unified |
| 89 | +[codesandbox]: https://codesandbox.io |
113 | 90 |
|
114 | | -[remark]: https://github.com/remarkjs/remark |
| 91 | +[creativecommons-by]: https://creativecommons.org/licenses/by/4.0/ |
115 | 92 |
|
116 | | -[retext]: https://github.com/retextjs/retext |
| 93 | +[file-code-of-conduct]: code-of-conduct.md |
117 | 94 |
|
118 | | -[rehype]: https://github.com/rehypejs/rehype |
| 95 | +[file-contributing]: contributing.md |
119 | 96 |
|
120 | | -[mdx]: https://github.com/mdx-js/mdx |
| 97 | +[github-search-discussions]: https://github.com/orgs/syntax-tree/discussions |
121 | 98 |
|
122 | | -[rubberduck]: https://rubberduckdebugging.com |
| 99 | +[github-search-issues]: https://github.com/search?q=user%3Asyntax-tree&type=issues |
123 | 100 |
|
124 | | -[xy]: https://meta.stackexchange.com/questions/66377/what-is-the-xy-problem/66378#66378 |
| 101 | +[rubberduckdebugging]: https://rubberduckdebugging.com |
125 | 102 |
|
126 | | -[codesandbox]: https://codesandbox.io |
| 103 | +[stackblitz]: https://stackblitz.com |
127 | 104 |
|
128 | | -[chat]: https://github.com/syntax-tree/unist/discussions |
| 105 | +[stackexchange-xy-problem]: https://meta.stackexchange.com/questions/66377/what-is-the-xy-problem/66378#66378 |
129 | 106 |
|
130 | | -[contributing]: contributing.md |
| 107 | +[wooorm]: https://wooorm.com |
0 commit comments