diff options
Diffstat (limited to '.github')
| -rw-r--r-- | .github/code-of-conduct.md | 136 | ||||
| -rw-r--r-- | .github/contribute.md | 57 | ||||
| -rw-r--r-- | .github/support.md | 46 |
3 files changed, 198 insertions, 41 deletions
diff --git a/.github/code-of-conduct.md b/.github/code-of-conduct.md new file mode 100644 index 0000000..8e24a76 --- /dev/null +++ b/.github/code-of-conduct.md @@ -0,0 +1,136 @@ +# Code of conduct + +## Our pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, caste, color, religion, or sexual +identity and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our standards + +Examples of behavior that contributes to a positive environment for our +community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +* Focusing on what is best not just for us as individuals, but for the overall + community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or advances + of any kind +* Trolling, insulting or derogatory comments, and personal or political + attacks +* Public or private harassment +* Publishing others’ private information, such as a physical or email address, + without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this code of conduct, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This code of conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official email address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at +`tituswormer@gmail.com`. +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement guidelines + +Community leaders will follow these guidelines in determining +the consequences for any action they deem in violation of this code of conduct: + +### 1. Correction + +**Community impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. +A public apology may be requested. + +### 2. Warning + +**Community impact**: A violation through a single incident or series of +actions. + +**Consequence**: A warning with consequences for continued behavior. +No interaction with the people involved, including unsolicited interaction with +those enforcing the code of conduct, for a specified period of time. +This includes avoiding interactions in community spaces as well as external +channels like social media. +Violating these terms may lead to a temporary or permanent ban. + +### 3. Temporary ban + +**Community impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. +No public or private interaction with the people involved, including +unsolicited interaction with those enforcing the code of conduct, is allowed +during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent ban + +**Community impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within the +community. + +## Attribution + +This code of conduct is adapted from the [contributor covenant][homepage], +version 2.1, available at +[`contributor-covenant.org/version/2/1/code_of_conduct.html`][v2.1]. + +Community impact guidelines were inspired by +[Mozilla’s code of conduct enforcement ladder][mozilla-coc]. + +For answers to common questions about this code of conduct, see the FAQ at +[`contributor-covenant.org/faq`][faq]. + +[homepage]: https://www.contributor-covenant.org + +[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html + +[mozilla-coc]: https://github.com/mozilla/inclusion + +[faq]: https://www.contributor-covenant.org/faq 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 diff --git a/.github/support.md b/.github/support.md index 7fd182d..afc8aaf 100644 --- a/.github/support.md +++ b/.github/support.md @@ -1,5 +1,9 @@ # Support +> 👉 **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 and where to get help. Please read through the following guidelines. @@ -12,23 +16,24 @@ Spend time framing questions and add links and resources. Spending the extra time up front helps save everyone time in the long run. Here are some tips: -- see [this article on _How do I ask a good question_][how-to-ask] for help -- [talk to a duck][rubberduck]! -- don’t fall for the [XY problem][xy] -- search to find out if a similar question has been asked -- try to define what you need help with: - - is there something in particular you want to do? - - what problem are you encountering and what steps have you taken to try - and fix it? - - is there a concept you don’t understand? -- provide sample code, if possible -- screenshots can help, but if there’s important text such as code or error - messages in them, please also provide those as text -- the more time you put into asking your question, the better we can help you +* see [*How do I ask a good question* by `StackOverflow`][how-to-ask] for a + good guide +* [talk to a duck][rubberduck]! +* don’t fall for the [XY problem][xy] +* search to find out if a similar question has been asked +* try to define what you need help with: + * is there something in particular you want to do? + * what problem are you encountering and what steps have you taken to try + and fix it? + * is there a concept you don’t understand? +* provide sample code, if possible +* screenshots can help, but if there’s important text such as code or error + messages in them, please also provide those as text +* the more time you put into asking your question, the better we can help you ## Contributions -See [`contributing.md`][contributing] on how to contribute. +See [`contribute.md`][contribute] on how to contribute. ## License @@ -37,10 +42,17 @@ See [`contributing.md`][contributing] on how to contribute. <!-- 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 + [rubberduck]: https://rubberduckdebugging.com + [xy]: https://meta.stackexchange.com/questions/66377/what-is-the-xy-problem/66378#66378 -[chat]: https://github.com/remarkjs/remark/discussions -[contributing]: contributing.md + +[chat]: https://github.com/wooorm/micromark-rs/discussions + +[contribute]: contribute.md + +[coc]: code-of-conduct.md + [how-to-ask]: https://stackoverflow.com/help/how-to-ask |