aboutsummaryrefslogtreecommitdiffstats
path: root/.github/contribute.md
diff options
context:
space:
mode:
authorLibravatar Titus Wormer <tituswormer@gmail.com>2022-10-12 13:13:02 +0200
committerLibravatar Titus Wormer <tituswormer@gmail.com>2022-10-12 13:13:02 +0200
commitd2a9d952919a05bf17e6bd9d4688a2b9df82fc78 (patch)
treeccc94fb196804e46bb147959186c85f94dbee2cb /.github/contribute.md
parente0485409fca79af0b47af15ebdba7a3df5c1d3d2 (diff)
downloadmarkdown-rs-d2a9d952919a05bf17e6bd9d4688a2b9df82fc78.tar.gz
markdown-rs-d2a9d952919a05bf17e6bd9d4688a2b9df82fc78.tar.bz2
markdown-rs-d2a9d952919a05bf17e6bd9d4688a2b9df82fc78.zip
Add code of conduct, improve docs
Diffstat (limited to '.github/contribute.md')
-rw-r--r--.github/contribute.md57
1 files changed, 33 insertions, 24 deletions
diff --git a/.github/contribute.md b/.github/contribute.md
index 18ef1ee..a59fe01 100644
--- a/.github/contribute.md
+++ b/.github/contribute.md
@@ -1,5 +1,9 @@
# Contribute
+> 👉 **Important**: this project has a [code of conduct][coc].
+> By interacting with this repository and community you agree to abide by its
+> terms.
+
This article explains how to contribute.
Please read through the following guidelines.
@@ -33,34 +37,34 @@ See [Project][] for more info.
## Submitting an issue
-- the issue tracker is for issues, discussions are for for questions
-- search the issue tracker (including closed issues) before opening a new
- issue
-- ensure you’re using the latest versions of packages and other tools
-- use a clear and descriptive title
-- include as much information as possible: steps to reproduce the issue,
- error message, version, operating system, etcetera
-- the more time you put into an issue, the better help you can get
-- the best issue report is a [failing test][unit-test] proving it
+* the issue tracker is for issues, discussions are for questions
+* search the issue tracker (including closed issues) before opening a new
+ issue
+* ensure you’re using the latest versions of packages and other tools
+* use a clear and descriptive title
+* include as much information as possible: steps to reproduce the issue,
+ error message, version, operating system, etcetera
+* the more time you put into an issue, the better help you can get
+* the best issue report is a [failing test][unit-test] proving it
## Submitting a pull request
-- run `cargo fmt` and `cargo test` locally to format and test your changes
-- non-trivial changes are often best discussed in an issue first, to prevent
- you from doing unnecessary work
-- for ambitious tasks, you should try to get your work in front of the
- community for feedback as soon as possible
-- new features should be accompanied by tests and documentation
-- don’t include unrelated changes
-- write a convincing description of why your pull request should land:
- it’s your job to be convincing
+* run `cargo fmt` and `cargo test` locally to format and test your changes
+* non-trivial changes are often best discussed in an issue first, to prevent
+ you from doing unnecessary work
+* for ambitious tasks, you should try to get your work in front of the
+ community for feedback as soon as possible
+* new features should be accompanied by tests and documentation
+* don’t include unrelated changes
+* write a convincing description of why your pull request should land:
+ it’s your job to be convincing
## Resources
-- [how to contribute to open source](https://opensource.guide/how-to-contribute/)
-- [making your first contribution](https://medium.com/@vadimdemedes/making-your-first-contribution-de6576ddb190)
-- [using pull requests](https://help.github.com/articles/about-pull-requests/)
-- [GitHub help](https://help.github.com)
+* [how to contribute to open source](https://opensource.guide/how-to-contribute/)
+* [making your first contribution](https://medium.com/@vadimdemedes/making-your-first-contribution-de6576ddb190)
+* [using pull requests](https://help.github.com/articles/about-pull-requests/)
+* [GitHub help](https://help.github.com)
## License
@@ -69,10 +73,15 @@ See [Project][] for more info.
<!-- Definitions -->
[license]: https://creativecommons.org/licenses/by/4.0/
+
[author]: https://wooorm.com
-[coc]: https://github.com/remarkjs/.github/blob/main/code-of-conduct.md
+
[unit-test]: https://twitter.com/sindresorhus/status/579306280495357953
+
[support]: support.md
-[collective]: https://opencollective.com/unified
+
+[coc]: code-of-conduct.md
+
[sponsor]: https://github.com/wooorm/micromark-rs/#sponsor
+
[project]: https://github.com/wooorm/micromark-rs/#project