From 4de1000c685ad522f882080cb35bedc5824f81da Mon Sep 17 00:00:00 2001 From: Jasmin <98263758+chloe-the-catgirl@users.noreply.github.com> Date: Wed, 14 Sep 2022 17:13:08 +0200 Subject: [PATCH] docs: prepare for hacktoberfest (#18) --- CODE_OF_CONDUCT.md | 141 ++++++++++++++++++++++++++++++++++++++++++++ CONTRIBUTING.md | 72 ++++++++++++++++++++++ docs/development.md | 28 +++++++++ 3 files changed, 241 insertions(+) create mode 100644 CODE_OF_CONDUCT.md create mode 100644 CONTRIBUTING.md create mode 100644 docs/development.md diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..032e927 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,141 @@ +# 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 an @chloe-the-catgirl oder @xenein oder der für die Durchsetzung +zuständigen Gemeinschaftsleitung gemeldet werden. 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 + + +Community Impact Guidelines wurden von +[Mozillas Code of Conduct Enforcement Ladder][mozilla] inspiriert. + +Antworten auf häufig gestellte Fragen zu diesem Verhaltenskodex finden Sie in +den häufig gestellten Fragen unter +(in Englisch). Andere Übersetzungen sind verfügbar unter +. + +[homepage]: https://www.contributor-covenant.org +[mozilla]: https://github.com/mozilla/inclusion diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..aff395a --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,72 @@ +# Willkommen beim Queer Lexikon Beteiligungs-Guide + +Vielen Dank dafür, dass du dazu beitragen möchstest, dieses Projekt zu verbessern! +Jeder Beitrag, egal wie groß oder klein, wird auf [karte.queer-lexikon.net](https://karte.queer-lexikon.net) gezeigt :sparkles:. + +Bevor du anfängst, wäre es großartig, unseren [Verhaltenskodex](./CODE_OF_CONDUCT.md) vorher zu lesen, +damit diese Community weiterhin respektvoll und zugänglich ist. + +In diesem Guide wirst du einen Überblick über den Workflow zur Beteiligung (en.: contribution) bekommen. + +## Für Neuzugänge + +Um einen Überblick über das Projekt und die Ziele zu bekommen, ist die [README](./README.md) geeignet. +Hier sind außerdem ein paar weitere Ressourcen, um mit Open-Source-Beteiligungen durchzustarten: + +- [Git aufsetzen](https://docs.github.com/en/get-started/quickstart/set-up-git) +- [GitHub flow](https://docs.github.com/en/get-started/quickstart/github-flow) +- [Über _Pull Requests_ beitragen](https://docs.github.com/en/github/collaborating-with-pull-requests) + +## Erste Schritte + +Wir sind für alle Arten von Verbesserungen offen. Selbst wenn du nur einen winzig kleinen Bug gefunden hast, +freuen wir uns darüber, wenn dieser berichtet wird :blush: + +### Issues + +#### Neues Issue erstellen + +Wenn du ein Problem mit der Karte entdeckt hast, schau erstmal, ob nicht [vielleicht bereits ein Issue dafür existiert](https://github.com/Queer-Lexikon/regenbogenkarte/issues). +Falls nicht, kannst du gerne jederzeit ein [neues Issue erstellen](https://github.com/Queer-Lexikon/regenbogenkarte/issues/new/choose). + +#### Issue lösen + +Du kannst auch gerne durch unsere [bestehenden Issues](https://github.com/Queer-Lexikon/regenbogenkarte/issues) stöbern und schauen, ob du etwas interessantes dabei entdeckst. +Wenn du was gefunden hast, bist du herzlichst eingeladen, ein Pull Request mit den Änderungen einzureichen. + +### Änderungen durchführen + +1. Repository forken. + +- mit GitHub Desktop: + + - [Getting started with GitHub Desktop](https://docs.github.com/en/desktop/installing-and-configuring-github-desktop/getting-started-with-github-desktop) wird dich durch die Installation von GitHub Desktop führen. + - Sobald GitHub Desktop eingerichtet ist, kannst du es zum [forken des Repositories](https://docs.github.com/en/desktop/contributing-and-collaborating-using-github-desktop/cloning-and-forking-repositories-from-github-desktop) nutzen! + +- mit der Kommandozeile: + - [Repository forken](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo#fork-an-example-repository), sodass du deine Änderungen vornehmen kannst, ohne dass das ursprüngliche Projekt verändert wird. + +2. Installiere oder aktualisiere auf **Node.js v16**. Für weitere Informationen, schau dir gern [den Entwicklungs-Guide an](docs/development.md). + +3. Erstelle einen neuen Branch und fang an, den Code anzupassen! + +### Änderungen committen + +Du kannst deine Änderungen committen, sobald du fertig bist. +Wir haben keine bestimmten Guidelines für das Schreiben von Commits, aber wenn du mit [konventionellen Commits](https://www.conventionalcommits.org/de/v1.0.0/) vertraut sein solltest, freuen wir uns natürlich, wenn du dem Muster folgst. + +### Pull Request + +Wenn du fertig bist, erstelle ein _Pull Request_, auch als "PR" bekannt. + +- Vergiss nicht, das [PR mit dem Issue zu verlinken](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue), sofern du eines löst. +- Setze den Haken bei ["allow maintainer edits"](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/allowing-changes-to-a-pull-request-branch-created-from-a-fork), sodass auch wir vom Team Änderungen vornehmen können. +- Sobald du das PR abgesendet hast, wird sich jemand vom Team dieses anschauen und gegebenfalls Fragen stellen oder weitere Informationen erfragen. + Ab und zu fragen wir auch nach ein paar weiteren Änderungen, die dann erforderlich sind, bevor wir dein PR mergen. + Aber keine Sorge, wir versuchen dich natürlich bestmöglich zu unterstützen! :blush: +- Falls du beim Mergen Probleme bekommst, schau dir das folgende [Git Tutorial](https://github.com/skills/resolve-merge-conflicts) an, um Merge-Konflikte und andere Probleme zu lösen. + +### Dein PR ist gemerged! + +Herzliche Glückwünsche :tada::tada: +Das gesamte Team vom Queer Lexikon dankt dir! :sparkles: diff --git a/docs/development.md b/docs/development.md new file mode 100644 index 0000000..7c8c56f --- /dev/null +++ b/docs/development.md @@ -0,0 +1,28 @@ +# Entwicklung + +Dieses Dokument beschreibt den Prozess, um diese Anwendung lokal auf deinem PC entwickeln und starten zu können. + +## Erste Schritte + +Wir nutzen primär TypeScript für die Entwicklung der Karte. Aber da jeder JavaScript-Code auch prinzipiell erstmal gültiges TypeScript ist, +sind natürlich auch Ergänzungen in JavaScript gerne gesehen. + +Für das CSS nutzen wir [Tailwind](https://tailwindcss.com/). Das erleichtert uns ein wenig die Entwicklung, aber wenn du damit noch keine Erfahrung +hast, würde es auch reichen, gewöhnliches CSS zu schreiben. + +Damit der ganze Spaß aber lokal auch läuft, brauchst du Node.js. Empfohlen ist Version 16 oder höher, dieses kannst du über den [LTS-Installer auf nodejs.org](https://nodejs.org) beziehen. + +Sobald Node.js installiert ist, welches den Paketmanager `npm` beinhaltet, öffne deine Konsole und führe den folgenden Code aus: + +```sh +git clone https://github.com/Queer-Lexikon/regenbogenkarte.git +npm ci +npm run dev +``` + +Du solltest nun eine lokale Version der Karte haben! Besuche [localhost:5173](http://localhost:5173) in deinem Browser. + +Sobald du fertig bist und den lokalen Server wieder stoppen willst, tippe Ctrl+C in deinem Terminal. + +`npm ci` muss in der Regel nur einmal ausgeführt werden, oder wenn du deinen Branch aktualisierst. +Der Befehl lädt die notwendigen Abhängigkeiten für die Regenbogenkarte herunter und installiert diese.