From c2306d1b75d3263acf6c8e8a0f5b382fb9f1dfb1 Mon Sep 17 00:00:00 2001 From: Kai Bernhard <17817496+kaibernhard@users.noreply.github.com> Date: Wed, 25 Oct 2023 20:29:42 +0200 Subject: [PATCH] docs: add code of conduct and contribution guidelines --- CODE_OF_CONDUCT.md | 134 +++++++++++++++++++++++++++++++++++++++++ CODE_OF_CONDUCT_DE.md | 135 ++++++++++++++++++++++++++++++++++++++++++ README.md | 29 +++++++++ 3 files changed, 298 insertions(+) create mode 100644 CODE_OF_CONDUCT.md create mode 100644 CODE_OF_CONDUCT_DE.md diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..d7d5ecb --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,134 @@ +# 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 +[github-community@digitalservice.bund.de](mailto:github-community@digitalservice.bund.de). Reports related +to the community leaders can be sent together with information about the involved +community leaders to [hallo@digitalservice.bund.de](mailto:hallo@digitalservice.bund.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][v2.0]. + +Community Impact Guidelines were inspired by +[Mozilla's code of conduct enforcement ladder][mozilla coc]. + +For answers to common questions about this code of conduct, see the FAQ at +[https://www.contributor-covenant.org/faq][faq]. Translations are available +at [https://www.contributor-covenant.org/translations][translations]. + +[homepage]: https://www.contributor-covenant.org +[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html +[mozilla coc]: https://github.com/mozilla/diversity +[faq]: https://www.contributor-covenant.org/faq +[translations]: https://www.contributor-covenant.org/translations diff --git a/CODE_OF_CONDUCT_DE.md b/CODE_OF_CONDUCT_DE.md new file mode 100644 index 0000000..9d42306 --- /dev/null +++ b/CODE_OF_CONDUCT_DE.md @@ -0,0 +1,135 @@ +# Vereinbarung über Verhaltenskodex für Mitwirkende + +## Unsere Verpflichtung + +Wir als Mitglieder, Teilnehmende und Verantwortliche unserer Gemeinschaft +verpflichten uns, allen Teilnehmenden an dem Projekt und unserer Gemeinschaft +eine belästigungsfreie Beteiligung, unabhängig von Alter, Körpergröße, +Behinderung, ethnischer Zuordnung, Geschlechtermerkmalen, -identität und -ausdruck, +Grad der Erfahrung, Bildung, sozialem Status, Nationalität, persönlicher +Erscheinung, Rasse, Religion oder sexueller Identität und Orientierung +zu ermöglichen. + +Wir verpflichten uns, in einer Weise zu handeln und zu interagieren, die zu +einer offenen, einladenden, vielfältigen, inklusiven und gesunden Gemeinschaft +beiträgt. + +## Unsere Standards + +Beispiele für Verhaltensweisen, die zu einem positiven Umfeld für unsere +Gemeinschaft beitragen, sind: + +- Einfühlungsvermögen und Freundlichkeit gegenüber anderen Menschen zeigen +- Unterschiedliche Meinungen, Standpunkte und Erfahrungen respektieren +- Konstruktives Feedback geben und würdevoll annehmen +- Verantwortung übernehmen und uns bei denjenigen entschuldigen, die von unseren + Fehlern betroffen sind, und aus den Erfahrungen lernen +- Konzentration auf das, was nicht nur für uns als Individuen, sondern für die + gesamte Gemeinschaft das Beste ist + +Beispiele für inakzeptables Verhalten sind: + +- Die Verwendung sexualisierter Sprache, Bilder oder Symbolik sowie unerwünschte + Versuche sexueller Annäherung +- Beleidigende oder abwertende Kommentare, persönliche oder politische Angriffe + und Trollen +- Öffentliche oder private Belästigungen +- Das Veröffentlichen von privaten Informationen Anderer, wie zum Beispiel + physische oder elektronische Adressen, ohne deren ausdrückliche Erlaubnis +- Anderes Verhalten, welches in einem professionellen Umfeld begründet als + unangemessen betrachtet werden kann + +## Verantwortlichkeiten bei der Durchsetzung + +Die Gemeinschaftsleitung ist verantwortlich dafür, unsere Standards für ein +akzeptables Verhalten klarzustellen und wird angemessen und fair +korrigierende Maßnahmen ergreifen um auf jegliches Verhalten, das sie für +unangemessen, bedrohlich oder beleidigend hält, zu reagieren. + +Die Gemeinschaftsleitung hat das Recht und die Verantwortung, Kommentare, +Commits, Code, Wiki-Bearbeitungen, Support-Tickets und andere Beiträge, die +nicht mit diesem Verhaltenskodex vereinbar sind, zu entfernen, zu bearbeiten +oder abzulehnen, und wird die Gründe für eine Mäßigung mitteilen, wenn es +angebracht ist. + +## Geltungsbereich + +Dieser Verhaltenskodex gilt für alle Gemeinschaftsbereiche und gilt auch, wenn +eine Einzelperson die Gemeinschaft offiziell in öffentlichen Bereichen vertritt. +Beispiele für die Repräsentation unserer Gemeinschaft sind die Verwendung einer +offiziellen E-Mail-Adresse, das Posten über ein offizielles Social-Media-Konto +oder das Auftreten als ernannte Vertretung bei einer Online- oder +Offline-Veranstaltung. + +## Durchsetzung + +Fälle von missbräuchlichem, belästigendem oder anderweitig inakzeptablem Verhalten +können unter [github-community@digitalservice.bund.de](mailto:github-community@digitalservice.bund.de) +der für die Durchsetzung zuständigen Gemeinschaftsleitung gemeldet werden. Fälle +im Zusammenhang mit Mitgliedern der Gemeinschaftsleitung können zusammen mit einem +Hinweis auf die beteiligten Mitglieder an [hallo@digitalservice.bund.de](mailto:hallo@digitalservice.bund.de) +gesendet werden und werden dann separat bearbeitet. Alle Beschwerden werden +zeitnah und fair geprüft und ermittelt. + +Die gesamte Gemeinschaftsleitung ist verpflichtet, die Privatsphäre und die +Sicherheit derjenigen, die einen Vorfall gemeldet haben, zu respektieren. + +## Durchsetzungsrichtlinien + +Die Gemeinschaftsleitung wird sich bei der Bestimmung der Konsequenzen für +jede Handlung, die ihrer Ansicht nach gegen diesen Verhaltenskodex verstößt, an +diese Richtlinien über die Auswirkungen in der Gemeinschaft halten: + +### 1. Berichtigung + +**Auswirkungen in der Gemeinschaft**: Verwendung unangemessener Sprache oder +anderes Verhalten, das in der Gemeinschaft als unprofessionell oder unwillkommen +gilt. + +**Folge**: Eine private, schriftliche Verwarnung der Gemeinschaftsleitung, +die Klarheit über die Art des Verstoßes und eine Erklärung dafür bietet, warum +das Verhalten unangemessen war. Eine öffentliche Entschuldigung kann verlangt +werden. + +### 2. Verwarnung + +**Auswirkungen in der Gemeinschaft**: Eine Verletzung durch einen einzelnen +Vorfall oder eine Reihe von Handlungen. + +**Folge**: Eine Warnung mit Konsequenzen bei wiederholtem Fehlverhalten. Keine +Interaktion mit den beteiligten Personen, einschließlich unaufgeforderter +Interaktion mit denjenigen, die den Verhaltenskodex durchsetzen, für einen +bestimmten Zeitraum. Dazu gehört die Vermeidung von Interaktionen in +Gemeinschaftsräumen sowie in externen Kanälen wie sozialen Medien. Ein Verstoß +gegen diese Bedingungen kann zu einem vorübergehenden oder dauerhaften Verbot +führen. + +### 3. Vorübergehender Ausschluss + +**Auswirkungen in der Gemeinschaft**: Eine schwerwiegende Verletzung von +Gemeinschaftsstandards, einschließlich anhaltend unangemessenen Verhaltens. + +**Folge**: Ein zeitlich begrenztes Verbot jeglicher Art von Interaktion oder +öffentlicher Kommunikation mit der Gemeinschaft. Während dieses Zeitraums ist +keine öffentliche oder private Interaktion mit den beteiligten Personen erlaubt. +Auch keine unaufgeforderte Interaktion mit denjenigen, die den Verhaltenskodex +durchsetzen. Ein Verstoß gegen diese Bedingungen kann zu einem dauerhaften +Verbot führen. + +### 4. Dauerhafter Ausschluss + +**Auswirkungen in der Gemeinschaft**: Aufzeigen eines Musters von Verletzungen +der Gemeinschaftsstandards, einschließlich anhaltend unangemessenen Verhaltens, +Belästigung einer Person oder Aggression gegen oder Herabsetzung von Gruppen von +Personen. + +**Folge**: Ein dauerhaftes Verbot jeglicher Art von öffentlicher Interaktion +innerhalb der Gemeinschaft. + +## Bezug + +Dieser Verhaltenskodex basiert auf dem [Contributor Covenant][homepage], +Version 2.0, verfügbar unter + + +[homepage]: https://www.contributor-covenant.org diff --git a/README.md b/README.md index 211e5a0..d0589c9 100644 --- a/README.md +++ b/README.md @@ -213,3 +213,32 @@ See https://github.com/npryce/adr-tools regarding usage. Opt in to CI posting notifications for failing jobs to a particular Slack channel by setting a repository secret with the name `SLACK_WEBHOOK_URL`, containing a URL for [Incoming Webhooks](https://api.slack.com/messaging/webhooks). + +## Contributing + +🇬🇧 +Everyone is welcome to contribute the development of the _kotlin-application-template_. You can contribute by opening pull request, +providing documentation or answering questions or giving feedback. Please always follow the guidelines and our +[Code of Conduct](CODE_OF_CONDUCT.md). + +🇩🇪 +Jede:r ist herzlich eingeladen, die Entwicklung der _kotlin-application-template_ mitzugestalten. Du kannst einen Beitrag leisten, +indem du Pull-Requests eröffnest, die Dokumentation erweiterst, Fragen beantwortest oder Feedback gibst. +Bitte befolge immer die Richtlinien und unseren [Verhaltenskodex](CODE_OF_CONDUCT_DE.md). + +### Contributing code + +🇬🇧 +Open a pull request with your changes and it will be reviewed by someone from the team. When you submit a pull request, +you declare that you have the right to license your contribution to the DigitalService and the community. +By submitting the patch, you agree that your contributions are licensed under the MIT license. + +Please make sure that your changes have been tested befor submitting a pull request. + +🇩🇪 +Nach dem Erstellen eines Pull Requests wird dieser von einer Person aus dem Team überprüft. Wenn du einen Pull Request +einreichst, erklärst du dich damit einverstanden, deinen Beitrag an den DigitalService und die Community zu +lizenzieren. Durch das Einreichen des Patches erklärst du dich damit einverstanden, dass deine Beiträge unter der +MIT-Lizenz lizenziert sind. + +Bitte stelle sicher, dass deine Änderungen getestet wurden, bevor du einen Pull Request sendest.