From 394b5d9a127e94876659991c3516f10cbf3e4f8e Mon Sep 17 00:00:00 2001 From: Justine Missik Date: Fri, 7 Jun 2024 17:17:59 -0400 Subject: [PATCH] add citation, code of contuct, contributor guide --- scripts/CITATION.cff | 25 ++++++++ scripts/CODE_OF_CONDUCT.md | 128 +++++++++++++++++++++++++++++++++++++ scripts/CONTRIBUTING.md | 23 +++++++ 3 files changed, 176 insertions(+) create mode 100644 scripts/CITATION.cff create mode 100644 scripts/CODE_OF_CONDUCT.md create mode 100644 scripts/CONTRIBUTING.md diff --git a/scripts/CITATION.cff b/scripts/CITATION.cff new file mode 100644 index 0000000..79e815c --- /dev/null +++ b/scripts/CITATION.cff @@ -0,0 +1,25 @@ +# This CITATION.cff file was generated with cffinit. +# Visit https://bit.ly/cffinit to generate yours today! + +cff-version: 1.2.0 +title: ECODATA +message: >- + If you use this software, please cite it as below. +type: software +authors: + - given-names: Justine + family-names: Missik + email: missik.2@osu.edu + orcid: 'https://orcid.org/0000-0002-6448-0694' + - given-names: Madeline + family-names: Scyphers + orcid: 'https://orcid.org/0000-0003-3733-4330' + - given-names: Sarah + family-names: Davidson + orcid: 'https://orcid.org/0000-0002-2766-9201' + - given-names: Gil + family-names: Bohrer + orcid: 'https://orcid.org/0000-0002-9209-9540' +repository-code: 'https://github.com/jemissik/ecodata' +url: 'https://ecodata-apps.readthedocs.io/' +license: MIT \ No newline at end of file diff --git a/scripts/CODE_OF_CONDUCT.md b/scripts/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..1b08908 --- /dev/null +++ b/scripts/CODE_OF_CONDUCT.md @@ -0,0 +1,128 @@ +# 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, 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 +missik.2@osu.edu. +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.0, available at +https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. + +Community Impact Guidelines were inspired by [Mozilla's code of conduct +enforcement ladder](https://github.com/mozilla/diversity). + +[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. \ No newline at end of file diff --git a/scripts/CONTRIBUTING.md b/scripts/CONTRIBUTING.md new file mode 100644 index 0000000..477981b --- /dev/null +++ b/scripts/CONTRIBUTING.md @@ -0,0 +1,23 @@ +# How to contribute to ECODATA-Animate + +## Did you find a bug? + +* **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/jemissik/ecodata/issues). If you find an existing issue describing your problem, please comment on that issue if you have additional details to report. + +* If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/jemissik/ecodata/issues/new/choose). Be sure to follow the instructions in the issue template and include as much relevant information as possible. + + +## Did you find a problem in the documentation? + +Did you find a mistake in the documentation, like incorrect instructions or a typo? Do you think more instructions are +needed for a particular topic? Please [open an issue](https://github.com/jemissik/ecodata/issues/new/choose) to report the problem. + + +## Do you want to contribute to the documentation? + +Please read our [guide](https://ecodata-apps.readthedocs.io/en/latest/developer_guide.html#documentation) for contributing to the documentation. + + +## Do you want to contribute to the code? + +Please read the [developer guide](https://ecodata.readthedocs.io/en/latest/developing.html). \ No newline at end of file