mirror of
https://github.com/Queer-Lexikon/regenbogenkarte
synced 2024-11-14 00:17:11 +00:00
73 lines
4.3 KiB
Markdown
73 lines
4.3 KiB
Markdown
|
# Willkommen beim Queer Lexikon Beteiligungs-Guide <!-- omit in toc -->
|
||
|
|
|
||
|
|
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:
|