Skip to content

Commit 76e2efe

Browse files
authored
Refactor contributing.md
Closes GH-7. Reviewed-by: Christian Murphy <[email protected]> Reviewed-by: Remco Haszing <[email protected]> Reviewed-by: Titus Wormer <[email protected]>
1 parent 2efdcbc commit 76e2efe

File tree

1 file changed

+83
-81
lines changed

1 file changed

+83
-81
lines changed

contributing.md

+83-81
Original file line numberDiff line numberDiff line change
@@ -1,124 +1,122 @@
11
# Contributing
22

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-
83
Hi!
94
👋
10-
We’re excited that you’re interested in contributing!
115
Take a moment to read the following guidelines.
12-
And thanks for contributing to **unist** (**syntax-tree**)!
13-
👏👌✨
14-
15-
If you’re raising an issue,
16-
please understand that people involved with this project often do so for fun,
17-
next to their day job;
18-
you are not entitled to free customer service.
6+
Thanks for contributing!
197

208
## Contents
219

10+
* [Expectations](#expectations)
2211
* [Ecosystem](#ecosystem)
12+
* [Support](#support)
2313
* [Contributions](#contributions)
2414
* [Financial support](#financial-support)
2515
* [Improve documentation](#improve-documentation)
2616
* [Improve issues](#improve-issues)
2717
* [Give feedback on issues](#give-feedback-on-issues)
2818
* [Write code](#write-code)
29-
* [Support](#support)
3019
* [Submitting an issue](#submitting-an-issue)
3120
* [Submitting a pull request](#submitting-a-pull-request)
3221
* [Resources](#resources)
3322
* [License](#license)
3423

24+
## Expectations
25+
26+
This community has a [code of conduct][file-code-of-conduct].
27+
You must follow it when interacting with the community.
28+
29+
Be respectful and considerate when asking for things.
30+
You are not entitled to free customer service.
31+
32+
Be friendly!
33+
Be excellent to each other.
34+
3535
## Ecosystem
3636

37-
The collective ([unified][]) consists of several organizations and separate
38-
projects: most of them are tiny,
39-
and many of them have a utility
40-
([`mdast-util-to-hast`][mdast-util-to-hast]),
41-
a plugin ([`remark-rehype`][remark-rehype]),
42-
and relate to an ecosystem ([`remark`][remark]) and a syntax tree ([mdast][]).
43-
Try and pick the right place to contribute to so we can help you faster.
37+
Pick the right place to contribute.
38+
The collective ([unified][github-unified]) is hundreds of projects in several
39+
organizations.
40+
Often there is
41+
a utility (such as [`mdast-util-to-hast`][github-mdast-util-to-hast]),
42+
a plugin ([`remark-rehype`][github-remark-rehype]),
43+
relating to a syntax tree ([mdast][github-mdast])
44+
and an ecosystem ([`remark`][github-remark]).
45+
If you are not sure where to contribute,
46+
you can first ask a question.
47+
48+
## Support
49+
50+
See [`support.md`][file-support] on how to get help.
4451

4552
## Contributions
4653

47-
There’s several ways to contribute,
48-
not just by writing code.
54+
There are several ways to contribute.
4955

5056
### Financial support
5157

52-
It’s possible to support us financially by becoming a backer or sponsor through
53-
[Open Collective][collective].
54-
With this support,
55-
we can pay for project leadership,
56-
finance non-coding work,
57-
or to do fun things for the community like getting stickers for contributors.
58-
You’ll be helping unified’s maintainers manage and improve existing projects,
59-
and additionally support our work to develop new and exciting projects,
60-
such as [micromark][].
58+
Support our efforts financially.
59+
Sponsor us on [GitHub][github-sponsors],
60+
[`thanks.dev`][thanks],
61+
or [OpenCollective][].
6162

6263
### Improve documentation
6364

64-
As a user of this project you’re perfect for helping us improve our docs.
65-
Typo corrections,
66-
error fixes,
67-
better explanations,
65+
Fix that typo.
66+
As a user you are perfect for helping us improve the docs.
67+
Better explanations,
6868
new examples,
6969
etcetera.
70-
Anything!
7170

7271
### Improve issues
7372

73+
Help make issues easier to resolve.
7474
Some issues lack information,
75-
aren’t reproducible,
75+
are not reproducible,
7676
or are just incorrect.
77-
Help make them easier to resolve.
7877

7978
### Give feedback on issues
8079

81-
We’re always looking for more opinions on discussions in the issue tracker.
80+
Share your perspective.
81+
We are often looking for more opinions,
82+
insights,
83+
and use cases.
8284

8385
### Write code
8486

85-
Code contributions are very welcome.
86-
It’s often good to first create an issue to report a bug or suggest a new
87-
feature before creating a pull request to prevent you from doing unnecessary
88-
work.
89-
90-
## Support
91-
92-
See [`support.md`][support] on how to get help.
87+
Contribute a test,
88+
patch a bug,
89+
add a feature.
90+
It’s often good to first create a discussion or an issue before a pull request.
91+
Perhaps there’s a reason things are the way they are.
92+
Or there’s an alternative solution.
9393

9494
## Submitting an issue
9595

96-
* the issue tracker is for issues.
97-
See [`support.md`][support] on how to get help.
98-
* search the issue tracker (including closed issues) before opening a new
99-
issue
100-
* ensure you’re using the latest version of projects
96+
* see [`support.md`][file-support] for help;
97+
the issue tracker is for issues
98+
* search [discussions][github-search-discussions] and
99+
[issues][github-search-issues] before opening something,
100+
include links to what you find
101+
* contribute a failing test if you can
102+
* use the latest version of projects
101103
* use a clear and descriptive title
102-
* include as much information as possible: steps to reproduce the issue,
103-
error message,
104-
version,
105-
operating system,
106-
etcetera
104+
* include as much information as possible
105+
* be friendly!
107106
* the more time you put into an issue,
108-
the more we will
109-
* the best issue report is a [failing test][unit-test] proving it
107+
the easier it is to help you
110108

111109
## Submitting a pull request
112110

113-
* non-trivial changes are often best discussed in an issue first,
114-
to prevent
115-
you from doing unnecessary work
111+
* non-trivial things are often best discussed first,
112+
to prevent you from doing unnecessary work
116113
* for ambitious tasks,
117-
you should try to get your work in front of the community for feedback as
118-
soon as possible
119-
* new features should be accompanied with tests and documentation
120-
* don’t include unrelated changes
121-
* lint and test before submitting code by running `$ npm test`
114+
try to get your work in front of the community for feedback as soon as
115+
possible
116+
* do one thing and do it well,
117+
do not include unrelated changes
118+
* include tests and documentation
119+
* run `npm test` to make sure everything’s still fine
122120
* write a convincing description of why we should land your pull request:
123121
it’s your job to convince us
124122

@@ -132,28 +130,32 @@ See [`support.md`][support] on how to get help.
132130
## License
133131

134132
This document has the following license:
135-
[CC-BY-4.0][license] © [Titus Wormer][author]
133+
[CC-BY-4.0][creativecommons-by] © [Titus Wormer][wooorm]
134+
135+
[creativecommons-by]: https://creativecommons.org/licenses/by/4.0/
136+
137+
[file-code-of-conduct]: code-of-conduct.md
136138

137-
[license]: https://creativecommons.org/licenses/by/4.0/
139+
[file-support]: support.md
138140

139-
[author]: http://wooorm.com
141+
[github-mdast-util-to-hast]: https://github.com/syntax-tree/mdast-util-to-hast
140142

141-
[coc]: https://github.com/syntax-tree/.github/blob/main/code-of-conduct.md
143+
[github-mdast]: https://github.com/syntax-tree/mdast
142144

143-
[mdast]: https://github.com/syntax-tree/mdast
145+
[github-remark-rehype]: https://github.com/remarkjs/remark-rehype
144146

145-
[unified]: https://github.com/unifiedjs/unified
147+
[github-remark]: https://github.com/remarkjs/remark
146148

147-
[remark]: https://github.com/remarkjs/remark
149+
[github-unified]: https://github.com/unifiedjs/unified
148150

149-
[mdast-util-to-hast]: https://github.com/syntax-tree/mdast-util-to-hast
151+
[github-search-discussions]: https://github.com/orgs/syntax-tree/discussions
150152

151-
[remark-rehype]: https://github.com/remarkjs/remark-rehype
153+
[github-search-issues]: https://github.com/search?q=user%3Asyntax-tree&type=issues
152154

153-
[unit-test]: https://twitter.com/sindresorhus/status/579306280495357953
155+
[github-sponsors]: https://github.com/sponsors/unifiedjs
154156

155-
[collective]: https://opencollective.com/unified
157+
[opencollective]: https://opencollective.com/unified
156158

157-
[micromark]: https://github.com/micromark/micromark
159+
[thanks]: https://thanks.dev
158160

159-
[support]: support.md
161+
[wooorm]: https://wooorm.com

0 commit comments

Comments
 (0)