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 +
**hast**! 👏👌✨
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 +
* [**syntax-tree**](https://gitter.im/syntax-tree/Lobby)
43 +
— Topics relating to [**syntax-tree**][syntax-tree] and [**unist**][unist]
44 +
* [**rehype**](https://gitter.im/wooorm/rehype)
45 +
— Topics relating to the [**rehype**][rehype] ecosystem, HTML,
46 +
and [**hast**][hast]
47 + 48 +
## Contributions
49 + 50 +
There’s several ways to contribute, not just by writing code.
51 + 52 +
### Improve documentation
53 + 54 +
As a user of this project you’re perfect for helping us improve our docs.
55 +
Typo corrections, error fixes, better explanations, new examples, etcetera.
56 +
Anything!
57 + 58 +
### Improve issues
59 + 60 +
Some issues lack information, aren’t reproducible, or are just incorrect.
61 +
Help make them easier to resolve.
62 + 63 +
### Give feedback on issues
64 + 65 +
We’re always looking for more opinions on discussions in the issue tracker.
66 + 67 +
### Write code
68 + 69 +
Code contributions are very welcome. It’s often good to first create an issue
70 +
to report a bug or suggest a new feature before creating a pull request to
71 +
prevent you from doing unnecessary work.
72 + 73 +
## Submitting an issue
74 + 75 +
* The issue tracker is for issues. Use chat for support
76 +
* Search the issue tracker (including closed issues) before opening a new
77 +
issue
78 +
* Ensure you’re using the latest version of projects
79 +
* Use a clear and descriptive title
80 +
* Include as much information as possible: steps to reproduce the issue,
81 +
error message, version, operating system, etcetera
82 +
* The more time you put into an issue, the more we will
83 +
* The best issue report is a [failing test][unit-test] proving it
84 + 85 +
## Submitting a pull request
86 + 87 +
* Non-trivial changes are often best discussed in an issue first, to prevent
88 +
you from doing unnecessary work
89 +
* For ambitious tasks, you should try to get your work in front of the
90 +
community for feedback as soon as possible
91 +
* New features should be accompanied with tests and documentation
92 +
* Don’t include unrelated changes
93 +
* Lint and test before submitting code by running `$ npm test`
94 +
* Write a convincing description of why we should land your pull request:
95 +
it’s your job to convince us
96 + 97 +
## Resources
98 + 99 +
* [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)
100 +
* [Making your first contribution](https://medium.com/@vadimdemedes/making-your-first-contribution-de6576ddb190)
101 +
* [Using Pull Requests](https://help.github.com/articles/about-pull-requests/)
102 +
* [GitHub Help](https://help.github.com)
103 + 104 +
[coc]: https://github.com/unifiedjs/unified/blob/master/code-of-conduct.md
105 + 106 +
[syntax-tree]: https://github.com/syntax-tree
107 + 108 +
[unist]: https://github.com/syntax-tree/unist
109 + 110 +
[hast]: https://github.com/syntax-tree/hast
111 + 112 +
[unified]: https://github.com/unifiedjs/unified
113 + 114 +
[remark]: https://github.com/wooorm/remark
115 + 116 +
[rehype]: https://github.com/wooorm/rehype
117 + 118 +
[mdast-util-to-hast]: https://github.com/syntax-tree/mdast-util-to-hast
119 + 120 +
[remark-rehype]: https://github.com/wooorm/remark-rehype
121 + 122 +
[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