From d8f651e9daf4d8d87f77a04dd35da1367a7ecdd7 Mon Sep 17 00:00:00 2001 From: Camille TJHOA Date: Sat, 10 Feb 2018 14:57:10 +0100 Subject: [PATCH] Add docs on contributing --- .github/PULL_REQUEST_TEMPLATE.md | 4 +++ CODE_OF_CONDUCT.md | 46 ++++++++++++++++++++++++++++++++ CONTRIBUTING.md | 36 +++++++++++++++++++++++++ MAINTAINERS.md | 1 + 4 files changed, 87 insertions(+) create mode 100644 .github/PULL_REQUEST_TEMPLATE.md create mode 100644 CODE_OF_CONDUCT.md create mode 100644 CONTRIBUTING.md create mode 100644 MAINTAINERS.md diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..189b667 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,4 @@ + + + + diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..1a772b9 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,46 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment include: + +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and unwelcome sexual attention or advances +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic address, without explicit permission +* Other conduct which could reasonably be considered inappropriate in a professional setting + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior. + +Project maintainers 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, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at PR. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version] + +[homepage]: http://contributor-covenant.org +[version]: http://contributor-covenant.org/version/1/4/ diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..b8f4985 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,36 @@ +# Contribution Guidelines + +This resource was made by the Rust community and wouldn't be possible without you! We appreciate and recognize [all contributors](https://github.com/ctjhoa/rust-learning/graphs/contributors). + +In order to contribute to this repository you need to **fork** it, then you can create a pull request. + + +# Contribution Guidelines + +- **To add, remove, or change things on the list:** Submit a pull request + +To set this list apart from and complement the excellent [Rust docs](https://www.rust-lang.org/en-US/documentation.html), rust-learning is a specially curated list for high-quality resources. + +- List items should be sorted *alphabetically*. +- Each item should be limited to one link. +- The link should have an author if known +- At least 3 items are needed to create a new category. + +Please contribute links to resources you have used or are familiar with. This will help ensure high-quality entries. + +If you removed our PR template you can find it [here](https://github.com/ctjhoa/rust-learning/blob/master/.github/PULL_REQUEST_TEMPLATE.md). + + +## Maintainers + +To make sure every PR is checked, we have [team maintainers](MAINTAINERS). Every PR should be reviewed by at least two maintainers before it can get merged if the team is not outnumbered. + +The maintainers will review your PR and notify you and tag it in case any information is still missing. +You can also apply to become a maintainer by submitting an issue. + + +## Reporting issues + +Please open an issue if you would like to discuss anything that could be improved or have suggestions for making the list a more valuable resource. We realize sometimes resources fall into abandonment or have broken links for extended periods of time, so if you see that, feel free to change its listing or let us know. We also realize that sometimes resources are just going through transitions. Removal changes will not be applied until they have been pending for a minimum of 1 week (7 days). This grace window benefits projects that may be going through a temporary transition but are otherwise worthy of being on the list. + +Thank you for your suggestions! diff --git a/MAINTAINERS.md b/MAINTAINERS.md new file mode 100644 index 0000000..dff54dd --- /dev/null +++ b/MAINTAINERS.md @@ -0,0 +1 @@ +Camille Tjhoa (@ctjhoa)