1 +
# Contributing
2 + 3 +
> This project has a [Code of Conduct][coc]. By interacting with this
4 +
> repository, organisation, or community you agree to abide by its terms.
5 + 6 +
Hi! 👋 Exciting that you’re interested in contributing! Before doing so, take
7 +
a moment to read the following guidelines. And thanks for contributing to
8 +
**unist**! 👏👌✨
9 + 10 +
Before anything else: people involved with this project often do so for fun,
11 +
next to their day job: you are not entitled to free customer service.
12 + 13 +
## Table of Contents
14 + 15 +
* [Ecosystem](#ecosystem)
16 +
* [Questions](#questions)
17 +
* [Contributions](#contributions)
18 +
* [Improve documentation](#improve-documentation)
19 +
* [Improve issues](#improve-issues)
20 +
* [Give feedback on issues](#give-feedback-on-issues)
21 +
* [Write code](#write-code)
22 +
* [Submitting an issue](#submitting-an-issue)
23 +
* [Submitting a pull request](#submitting-a-pull-request)
24 +
* [Resources](#resources)
25 + 26 +
## Ecosystem
27 + 28 +
The ecosystem consists of several organisations and separate projects: most of
29 +
them are tiny, and many of them have a utility
30 +
([`mdast-util-to-hast`][mdast-util-to-hast]), a plugin
31 +
([`remark-rehype`][remark-rehype]), and relate to an ecosystem
32 +
([`remark`][remark]). Try and pick the right place to contribute to so we can
33 +
help you faster.
34 + 35 +
## Questions
36 + 37 +
Please chat and ask questions on Gitter! Jump in there and lurk, talk to us,
38 +
and help others.
39 + 40 +
* [**unified**](https://gitter.im/unifiedjs/Lobby)
41 +
— Topics relating to [**unified**][unified] in general
42 +
* [**vfile**](https://gitter.im/vfile/Lobby)
43 +
— Topics relating to [**vfile**][vfile]: virtual files
44 +
* [**syntax-tree**](https://gitter.im/syntax-tree/Lobby)
45 +
— Topics relating to [**syntax-tree**][syntax-tree] and [**unist**][unist]
46 +
* [**remark**](https://gitter.im/wooorm/remark)
47 +
— Topics relating to the [**remark**][remark] ecosystem, markdown,
48 +
and [**mdast**][mdast]
49 +
* [**rehype**](https://gitter.im/wooorm/rehype)
50 +
— Topics relating to the [**rehype**][rehype] ecosystem, HTML,
51 +
and [**hast**][hast]
52 +
* [**retext**](https://gitter.im/wooorm/retext)
53 +
— Topics relating to the [**retext**][retext] ecosystem, natural language,
54 +
and [**nlcst**][nlcst]
55 + 56 +
## Contributions
57 + 58 +
There’s several ways to contribute, not just by writing code.
59 + 60 +
### Improve documentation
61 + 62 +
As a user of this project you’re perfect for helping us improve our docs.
63 +
Typo corrections, error fixes, better explanations, new examples, etcetera.
64 +
Anything!
65 + 66 +
### Improve issues
67 + 68 +
Some issues lack information, aren’t reproducible, or are just incorrect.
69 +
Help make them easier to resolve.
70 + 71 +
### Give feedback on issues
72 + 73 +
We’re always looking for more opinions on discussions in the issue tracker.
74 + 75 +
### Write code
76 + 77 +
Code contributions are very welcome. It’s often good to first create an issue
78 +
to report a bug or suggest a new feature before creating a pull request to
79 +
prevent you from doing unnecessary work.
80 + 81 +
## Submitting an issue
82 + 83 +
* The issue tracker is for issues. Use chat for support
84 +
* Search the issue tracker (including closed issues) before opening a new
85 +
issue
86 +
* Ensure you’re using the latest version of projects
87 +
* Use a clear and descriptive title
88 +
* Include as much information as possible: steps to reproduce the issue,
89 +
error message, version, operating system, etcetera
90 +
* The more time you put into an issue, the more we will
91 +
* The best issue report is a [failing test][unit-test] proving it
92 + 93 +
## Submitting a pull request
94 + 95 +
* Non-trivial changes are often best discussed in an issue first, to prevent
96 +
you from doing unnecessary work
97 +
* For ambitious tasks, you should try to get your work in front of the
98 +
community for feedback as soon as possible
99 +
* New features should be accompanied with tests and documentation
100 +
* Don’t include unrelated changes
101 +
* Lint and test before submitting code by running `$ npm test`
102 +
* Write a convincing description of why we should land your pull request:
103 +
it’s your job to convince us
104 + 105 +
## Resources
106 + 107 +
* [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)
108 +
* [Making your first contribution](https://medium.com/@vadimdemedes/making-your-first-contribution-de6576ddb190)
109 +
* [Using Pull Requests](https://help.github.com/articles/about-pull-requests/)
110 +
* [GitHub Help](https://help.github.com)
111 + 112 +
[coc]: https://github.com/unifiedjs/unified/blob/master/code-of-conduct.md
113 + 114 +
[vfile]: https://github.com/vfile
115 + 116 +
[syntax-tree]: https://github.com/syntax-tree
117 + 118 +
[unist]: https://github.com/syntax-tree/unist
119 + 120 +
[mdast]: https://github.com/syntax-tree/mdast
121 + 122 +
[nlcst]: https://github.com/syntax-tree/nlcst
123 + 124 +
[hast]: https://github.com/syntax-tree/hast
125 + 126 +
[unified]: https://github.com/unifiedjs/unified
127 + 128 +
[remark]: https://github.com/wooorm/remark
129 + 130 +
[retext]: https://github.com/wooorm/retext
131 + 132 +
[rehype]: https://github.com/wooorm/rehype
133 + 134 +
[mdast-util-to-hast]: https://github.com/syntax-tree/mdast-util-to-hast
135 + 136 +
[remark-rehype]: https://github.com/wooorm/remark-rehype
137 + 138 +
[unit-test]: https://twitter.com/sindresorhus/status/579306280495357953
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4