diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000000..b335b7f0e5 --- /dev/null +++ b/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 +florian.sihler@uni-ulm.de. +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/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000000..467a5f9dd4 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,50 @@ +# Thank You, for Every Contribution + +Before you commit, please enable the project-specific git-hooks by running: + +```shell +git config --local core.hooksPath .githooks/ +``` + +If you have any questions, refer to the [wiki](https://github.com/Code-Inspect/flowr/wiki) or just send me a mail at: . + + +## Commit Messages + +We structure our commit messages (enforced by our git-hooks) using the format `: `. +Currently, the following types are at your disposal (more may have been or are still available, but please restrict yourself to the following): + + +| name | description | +|:---------------|----------------------------------------------------------------------------------------------------| +| `feat` | Introduced a new feature. | +| `test`/`tests` | Introduced new or modified existing tests. | +| `refactor` | Represents a refactoring of existing code. | +| `ci` | Updated the ci pipeline of *flowR*. | +| `git` | Performed something git-specific (like updating the git-hooks). | +| `lint` | Adapted or updated linter-issues. | +| `doc` | Updated the documentation of *flowR*. | +| `typo` | Dealt with a small typo/a grammatical mistake. | +| `log` | Improved or updated the logging of *flowR*. | +| `ts` | Performed something typescript-specific (e.g., reconfigured the `tsconfig.json`). | +| `wip` | *Use this only in combination with another type*. It marks the commit to be unfinished. | +| `special` | *Use this only if none of the other categories apply*. Explain the details in your commit message. | + + +You can suffix each type with either + +* `-fix` to denote that you fixed the respective type (this is potentially redundant when used in combination with a type like `typo` and can be omitted there) +* `-fail` to denote an expected failure of the corresponding addition (usually combined with `wip` because the corresponding feature or test ist not completed yet) + +Furthermore, types can be combined with a comma followed by an optional space. +Although you can give the same type repeatedly - if you think you should, please consider splitting the commit into multiple smaller commits. + + +With this, the artificial message + +> `feat, test-fix: Support for branching in dataflow, fixed branching-test` + +represents the addition of a new feature and the fix of a corresponding test. + +To skip the `ci`, you can prefix the commit message with `[skip ci]`. +