Skip to content

Commit 7f1f6db

Browse files
committed
Refactor contributing.md
1 parent 41f88d9 commit 7f1f6db

File tree

1 file changed

+91
-72
lines changed

1 file changed

+91
-72
lines changed

contributing.md

Lines changed: 91 additions & 72 deletions
Original file line numberDiff line numberDiff line change
@@ -1,107 +1,123 @@
11
# Contributing
22

3-
> This project has a [code of conduct][coc].
4-
> By interacting with this repository, organization, or community you agree to
5-
> abide by its terms.
6-
73
Hi!
84
👋
9-
We’re excited that you’re interested in contributing!
105
Take a moment to read the following guidelines.
11-
And thanks for contributing to **unified**!
12-
👏👌✨
13-
14-
If you’re raising an issue, please understand that people involved with this
15-
project often do so for fun, next to their day job; you are not entitled to
16-
free customer service.
6+
Thanks for contributing!
177

188
## Contents
199

10+
* [Expectations](#expectations)
2011
* [Ecosystem](#ecosystem)
12+
* [Support](#support)
2113
* [Contributions](#contributions)
2214
* [Financial support](#financial-support)
2315
* [Improve documentation](#improve-documentation)
2416
* [Improve issues](#improve-issues)
2517
* [Give feedback on issues](#give-feedback-on-issues)
2618
* [Write code](#write-code)
27-
* [Support](#support)
2819
* [Submitting an issue](#submitting-an-issue)
2920
* [Submitting a pull request](#submitting-a-pull-request)
3021
* [Resources](#resources)
3122
* [License](#license)
3223

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+
3335
## Ecosystem
3436

35-
The collective ([unified][]) consists of several organizations and separate
36-
projects: most of them are tiny, and many of them have a utility
37-
([`mdast-util-to-hast`][mdast-util-to-hast]), a plugin
38-
([`remark-rehype`][remark-rehype]), and relate to an ecosystem
39-
([`remark`][remark]) and a syntax tree ([mdast][]).
40-
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.
4151

4252
## Contributions
4353

44-
There’s several ways to contribute, not just by writing code.
54+
There are several ways to contribute.
4555

4656
### Financial support
4757

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

5663
### Improve documentation
5764

58-
As a user of this project you’re perfect for helping us improve our docs.
59-
Typo corrections, error fixes, better explanations, new examples, etcetera.
60-
Anything!
65+
Fix that typo.
66+
As a user you are perfect for helping us improve the docs.
67+
Better explanations,
68+
new examples,
69+
etcetera.
6170

6271
### Improve issues
6372

64-
Some issues lack information, aren’t reproducible, or are just incorrect.
65-
Help make them easier to resolve.
73+
Help make issues easier to resolve.
74+
Some issues lack information,
75+
are not reproducible,
76+
or are just incorrect.
6677

6778
### Give feedback on issues
6879

69-
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.
7084

7185
### Write code
7286

73-
Code contributions are very welcome.
74-
It’s often good to first create an issue to report a bug or suggest a new
75-
feature before creating a pull request to prevent you from doing unnecessary
76-
work.
77-
78-
## Support
79-
80-
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.
8193

8294
## Submitting an issue
8395

84-
* The issue tracker is for issues.
85-
See [`support.md`][support] on how to get help.
86-
* Search the issue tracker (including closed issues) before opening a new
87-
issue
88-
* Ensure you’re using the latest version of projects
89-
* Use a clear and descriptive title
90-
* Include as much information as possible: steps to reproduce the issue,
91-
error message, version, operating system, etcetera
92-
* The more time you put into an issue, the more we will
93-
* The best issue report is a [failing test][unit-test] proving it
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
103+
* use a clear and descriptive title
104+
* include as much information as possible
105+
* be friendly!
106+
* the more time you put into an issue,
107+
the easier it is to help you
94108

95109
## Submitting a pull request
96110

97-
* Non-trivial changes are often best discussed in an issue first, to prevent
98-
you from doing unnecessary work
99-
* For ambitious tasks, you should try to get your work in front of the
100-
community for feedback as soon as possible
101-
* New features should be accompanied with tests and documentation
102-
* Don’t include unrelated changes
103-
* Lint and test before submitting code by running `$ npm test`
104-
* Write a convincing description of why we should land your pull request:
111+
* non-trivial things are often best discussed first,
112+
to prevent you from doing unnecessary work
113+
* for ambitious tasks,
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
120+
* write a convincing description of why we should land your pull request:
105121
it’s your job to convince us
106122

107123
## Resources
@@ -113,30 +129,33 @@ See [`support.md`][support] on how to get help.
113129

114130
## License
115131

116-
[CC-BY-4.0][license] © [Titus Wormer][author]
132+
This document has the following license:
133+
[CC-BY-4.0][creativecommons-by] © [Titus Wormer][wooorm]
134+
135+
[creativecommons-by]: https://creativecommons.org/licenses/by/4.0/
117136

118-
<!-- Definitions -->
137+
[file-code-of-conduct]: code-of-conduct.md
119138

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

122-
[author]: https://wooorm.com
141+
[github-mdast-util-to-hast]: https://github.com/syntax-tree/mdast-util-to-hast
123142

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

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

128-
[unified]: https://github.com/unifiedjs/unified
147+
[github-remark]: https://github.com/remarkjs/remark
129148

130-
[remark]: https://github.com/remarkjs/remark
149+
[github-unified]: https://github.com/unifiedjs/unified
131150

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

134-
[remark-rehype]: https://github.com/remarkjs/remark-rehype
153+
[github-search-issues]: https://github.com/search?q=user%3Aunifiedjs&type=issues
135154

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

138-
[collective]: https://opencollective.com/unified
157+
[opencollective]: https://opencollective.com/unified
139158

140-
[micromark]: https://github.com/micromark/micromark
159+
[thanks]: https://thanks.dev
141160

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

0 commit comments

Comments
 (0)