From 15547a70a3246b1c7f06945de6f338eac0e44c15 Mon Sep 17 00:00:00 2001 From: Tim 'mithro' Ansell Date: Thu, 7 May 2020 14:32:21 -0700 Subject: [PATCH] Convert docs from Markdown to RST. This repository will use RST heavily for all it's documentation and it is good for these documents to be the same. Signed-off-by: Tim 'mithro' Ansell --- docs/code-of-conduct.md | 63 ------------------------------------- docs/code-of-conduct.rst | 67 ++++++++++++++++++++++++++++++++++++++++ docs/contributing.md | 28 ----------------- docs/contributing.rst | 33 ++++++++++++++++++++ 4 files changed, 100 insertions(+), 91 deletions(-) delete mode 100644 docs/code-of-conduct.md create mode 100644 docs/code-of-conduct.rst delete mode 100644 docs/contributing.md create mode 100644 docs/contributing.rst diff --git a/docs/code-of-conduct.md b/docs/code-of-conduct.md deleted file mode 100644 index f8b12cb..0000000 --- a/docs/code-of-conduct.md +++ /dev/null @@ -1,63 +0,0 @@ -# Google Open Source Community Guidelines - -At Google, we recognize and celebrate the creativity and collaboration of open -source contributors and the diversity of skills, experiences, cultures, and -opinions they bring to the projects and communities they participate in. - -Every one of Google's open source projects and communities are inclusive -environments, based on treating all individuals respectfully, regardless of -gender identity and expression, sexual orientation, disabilities, -neurodiversity, physical appearance, body size, ethnicity, nationality, race, -age, religion, or similar personal characteristic. - -We value diverse opinions, but we value respectful behavior more. - -Respectful behavior includes: - -* Being considerate, kind, constructive, and helpful. -* Not engaging in demeaning, discriminatory, harassing, hateful, sexualized, or - physically threatening behavior, speech, and imagery. -* Not engaging in unwanted physical contact. - -Some Google open source projects [may adopt][] an explicit project code of -conduct, which may have additional detailed expectations for participants. Most -of those projects will use our [modified Contributor Covenant][]. - -[may adopt]: https://opensource.google/docs/releasing/preparing/#conduct -[modified Contributor Covenant]: https://opensource.google/docs/releasing/template/CODE_OF_CONDUCT/ - -## Resolve peacefully - -We do not believe that all conflict is necessarily bad; healthy debate and -disagreement often yields positive results. However, it is never okay to be -disrespectful. - -If you see someone behaving disrespectfully, you are encouraged to address the -behavior directly with those involved. Many issues can be resolved quickly and -easily, and this gives people more control over the outcome of their dispute. -If you are unable to resolve the matter for any reason, or if the behavior is -threatening or harassing, report it. We are dedicated to providing an -environment where participants feel welcome and safe. - -## Reporting problems - -Some Google open source projects may adopt a project-specific code of conduct. -In those cases, a Google employee will be identified as the Project Steward, -who will receive and handle reports of code of conduct violations. In the event -that a project hasn’t identified a Project Steward, you can report problems by -emailing opensource@google.com. - -We will investigate every complaint, but you may not receive a direct response. -We will use our discretion in determining when and how to follow up on reported -incidents, which may range from not taking action to permanent expulsion from -the project and project-sponsored spaces. We will notify the accused of the -report and provide them an opportunity to discuss it before any action is -taken. The identity of the reporter will be omitted from the details of the -report supplied to the accused. In potentially harmful situations, such as -ongoing harassment or threats to anyone's safety, we may take action without -notice. - -*This document was adapted from the [IndieWeb Code of Conduct][] and can also -be found at .* - -[IndieWeb Code of Conduct]: https://indieweb.org/code-of-conduct diff --git a/docs/code-of-conduct.rst b/docs/code-of-conduct.rst new file mode 100644 index 0000000..ce5665d --- /dev/null +++ b/docs/code-of-conduct.rst @@ -0,0 +1,67 @@ +Google Open Source Community Guidelines +======================================= + +At Google, we recognize and celebrate the creativity and collaboration +of open source contributors and the diversity of skills, experiences, +cultures, and opinions they bring to the projects and communities they +participate in. + +Every one of Google's open source projects and communities are inclusive +environments, based on treating all individuals respectfully, regardless +of gender identity and expression, sexual orientation, disabilities, +neurodiversity, physical appearance, body size, ethnicity, nationality, +race, age, religion, or similar personal characteristic. + +We value diverse opinions, but we value respectful behavior more. + +Respectful behavior includes: + +- Being considerate, kind, constructive, and helpful. +- Not engaging in demeaning, discriminatory, harassing, hateful, + sexualized, or physically threatening behavior, speech, and imagery. +- Not engaging in unwanted physical contact. + +Some Google open source projects `may +adopt `__ +an explicit project code of conduct, which may have additional detailed +expectations for participants. Most of those projects will use our +`modified Contributor +Covenant `__. + +Resolve peacefully +------------------ + +We do not believe that all conflict is necessarily bad; healthy debate +and disagreement often yields positive results. However, it is never +okay to be disrespectful. + +If you see someone behaving disrespectfully, you are encouraged to +address the behavior directly with those involved. Many issues can be +resolved quickly and easily, and this gives people more control over the +outcome of their dispute. If you are unable to resolve the matter for +any reason, or if the behavior is threatening or harassing, report it. +We are dedicated to providing an environment where participants feel +welcome and safe. + +Reporting problems +------------------ + +Some Google open source projects may adopt a project-specific code of +conduct. In those cases, a Google employee will be identified as the +Project Steward, who will receive and handle reports of code of conduct +violations. In the event that a project hasn’t identified a Project +Steward, you can report problems by emailing opensource@google.com. + +We will investigate every complaint, but you may not receive a direct +response. We will use our discretion in determining when and how to +follow up on reported incidents, which may range from not taking action +to permanent expulsion from the project and project-sponsored spaces. We +will notify the accused of the report and provide them an opportunity to +discuss it before any action is taken. The identity of the reporter will +be omitted from the details of the report supplied to the accused. In +potentially harmful situations, such as ongoing harassment or threats to +anyone's safety, we may take action without notice. + +*This document was adapted from the `IndieWeb Code of +Conduct `__ and can also be found +at https://opensource.google/conduct/.* diff --git a/docs/contributing.md b/docs/contributing.md deleted file mode 100644 index 654a071..0000000 --- a/docs/contributing.md +++ /dev/null @@ -1,28 +0,0 @@ -# How to Contribute - -We'd love to accept your patches and contributions to this project. There are -just a few small guidelines you need to follow. - -## Contributor License Agreement - -Contributions to this project must be accompanied by a Contributor License -Agreement. You (or your employer) retain the copyright to your contribution; -this simply gives us permission to use and redistribute your contributions as -part of the project. Head over to to see -your current agreements on file or to sign a new one. - -You generally only need to submit a CLA once, so if you've already submitted one -(even if it was for a different project), you probably don't need to do it -again. - -## Code reviews - -All submissions, including submissions by project members, require review. We -use GitHub pull requests for this purpose. Consult -[GitHub Help](https://help.github.com/articles/about-pull-requests/) for more -information on using pull requests. - -## Community Guidelines - -This project follows [Google's Open Source Community -Guidelines](https://opensource.google/conduct/). diff --git a/docs/contributing.rst b/docs/contributing.rst new file mode 100644 index 0000000..4604acb --- /dev/null +++ b/docs/contributing.rst @@ -0,0 +1,33 @@ +How to Contribute +================= + +We'd love to accept your patches and contributions to this project. +There are just a few small guidelines you need to follow. + +Contributor License Agreement +----------------------------- + +Contributions to this project must be accompanied by a Contributor +License Agreement. You (or your employer) retain the copyright to your +contribution; this simply gives us permission to use and redistribute +your contributions as part of the project. Head over to +https://cla.developers.google.com/ to see your current agreements on +file or to sign a new one. + +You generally only need to submit a CLA once, so if you've already +submitted one (even if it was for a different project), you probably +don't need to do it again. + +Code reviews +------------ + +All submissions, including submissions by project members, require +review. We use GitHub pull requests for this purpose. Consult `GitHub +Help `__ for more +information on using pull requests. + +Community Guidelines +-------------------- + +This project follows `Google's Open Source Community +Guidelines `__.