From 21f60f77b4c8a029b2adb26eb0a548ed8a804e94 Mon Sep 17 00:00:00 2001 From: Yalin Date: Mon, 2 Oct 2023 15:33:17 -0400 Subject: [PATCH] add code of conducts to doc site, update links --- docs/source/CODE_OF_CONDUCT.rst | 140 ++++++++++++++++++++++++++++++++ docs/source/index.rst | 13 ++- 2 files changed, 149 insertions(+), 4 deletions(-) create mode 100644 docs/source/CODE_OF_CONDUCT.rst diff --git a/docs/source/CODE_OF_CONDUCT.rst b/docs/source/CODE_OF_CONDUCT.rst new file mode 100644 index 00000000..11d882be --- /dev/null +++ b/docs/source/CODE_OF_CONDUCT.rst @@ -0,0 +1,140 @@ +Contributor Covenant 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 e-mail 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 +quantitative.sustainable.design@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 Community Impact 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 +https://www.contributor-covenant.org/version/2/1/code_of_conduct.html. + +Community Impact Guidelines were inspired by `Mozilla's code of conduct +enforcement ladder `_. + +.. _homepage: https://www.contributor-covenant.org + +For answers to common questions about this code of conduct, see the FAQ at +https://www.contributor-covenant.org/faq. Translations are available at +https://www.contributor-covenant.org/translations. diff --git a/docs/source/index.rst b/docs/source/index.rst index 954c34a8..1de6d64b 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -78,14 +78,12 @@ You can also download the package from `PyPI ` Note that development of this package is currently under initial stage with limited backward compatibility, please feel free to `submit an issue `_ for any questions regarding package upgrading. -If you are a developer and want to contribute to ``QSDsan``, please follow the steps in the `contributing`_ section of the documentation to clone the repository. - Join the Community ------------------ We would like to build an open and welcoming community, you can always post issues on our `GitHub homepage `_ or contact any of the Quantitative Sustainable Design Group members. We are always excited to have new members in our team. -If you would like to contribute, please follow our `contributing`_ guidelines and the `code of conduct `_ (a bonus if you use our `templates `_), thank you for making ``QSDsan`` better! +If you would like to contribute, please follow our `Contributing Guidelines`_ and the `Code of Conduct `_ (a bonus if you use our `templates `_), thank you for making ``QSDsan`` better! ``QSDsan`` is and will stay open source under University of Illinois/NCSA Open Source License. Any third-party packages copied from ``QSDsan`` must be strictly open-source (not copy-left nor open-access). Please refer to the `license `_ page for details. @@ -141,6 +139,13 @@ We will keep the calendar up-to-date as we organize more events (office hours, w CONTRIBUTING +.. toctree:: + :maxdepth: 1 + :hidden: + + CODE_OF_CONDUCT + + .. toctree:: :maxdepth: 1 :hidden: @@ -165,4 +170,4 @@ References .. Links -.. _contributing: CONTRIBUTING.html \ No newline at end of file +.. _Contributing Guidelines: CONTRIBUTING.html#contributing-guidelines \ No newline at end of file