From afb74066d9ad40e0737cddaccdea03bc89066210 Mon Sep 17 00:00:00 2001 From: David Schneider Date: Thu, 24 Oct 2024 07:54:16 +0200 Subject: [PATCH] Add community guidelines (#205) * Add a code_of_conduct based on covenant * Add changelog entry * minor WIP * Add contributing guidelines * update changelog * Apply suggestions from code review Co-authored-by: Benjamin Uekermann --------- Co-authored-by: Benjamin Uekermann --- CODE_OF_CONDUCT.md | 130 +++++++++++++++++++++++++++++++++++++++ changelog-entries/205.md | 2 + docs/CONTRIBUTING.md | 31 ++++++++++ 3 files changed, 163 insertions(+) create mode 100644 CODE_OF_CONDUCT.md create mode 100644 changelog-entries/205.md create mode 100644 docs/CONTRIBUTING.md diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 00000000..ad39c9fd --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,130 @@ +# 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 +info at precice.org. +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. diff --git a/changelog-entries/205.md b/changelog-entries/205.md new file mode 100644 index 00000000..b31833fe --- /dev/null +++ b/changelog-entries/205.md @@ -0,0 +1,2 @@ +- Added a code of conduct from Covenant (see `CODE_OF_CONDUCT.md`). +- Added contributing guidelines (see `docs/CONTRIBUTING.md`). diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md new file mode 100644 index 00000000..1c665b2a --- /dev/null +++ b/docs/CONTRIBUTING.md @@ -0,0 +1,31 @@ +# Contributing to ASTE + +**Thank you for considering contributing to our project! We welcome contributions of all kinds.** + +The documentation of ASTE is rendered on [the preCICE website](https://precice.org/tooling-aste.html) and hosted in this repository under `./docs/README.md`. + +## Reporting Bugs + +- Ensure the bug is not already reported by searching [in our GitHub issues](https://github.com/precice/aste/issues). +- Use a clear and descriptive title. +- Provide details on how to reproduce the specific bug. + +## Submitting Pull Requests + +See the [contribute to preCICE page](https://precice.org/community-contribute-to-precice.html) for general guidelines. + +### Testing + +ASTE uses [`CMake`](https://cmake.org/) as build system. Code changes can be tested using the command `ctest`, which is also run by a GitHub Action workflow. It executes unit tests located in `./tests/` and integration tests located in `./examples/`. Add tests for new features in your pull request. For unit tests, have a look at `./tests/read_test.cpp` as an example. To add an integration test, add a new directory in `./examples/` and include a `run.sh` script and a `clean.sh` script. For an integration test example, have a look at `./examples/nn`. + +### Changelog + +We curate a `CHANGELOG.md` file, which tracks notable changes of this project across releases. Add a changelog entry when contributing. However, instead of directly editing `CHANGELOG.md`, please add a file `123.md` in `changelog-entries`, where `123` is your pull request number. This helps reducing merge conflicts. We collect these files before releasing. + +### Code formatting + +Similar to [preCICE](https://precice.org/dev-docs-dev-tooling.html#setting-up-pre-commit), we use pre-commit to ensure consistent formatting of source code and documentation files. Under the hood, pre-commit uses clang-format and black as formatters. Install [pre-commit](https://pre-commit.com/) and then call `pre-commit install` at the root of this repository to setup the automation. + +## Contact + +For questions, reach out through the [preCICE community channels](https://precice.org/community-channels.html).