regenbogenkarte/CONTRIBUTING.md

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 gezeigt ✨.

Bevor du anfängst, wäre es großartig, unseren Verhaltenskodex 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 geeignet. Hier sind außerdem ein paar weitere Ressourcen, um mit Open-Source-Beteiligungen durchzustarten:

• Git aufsetzen
• GitHub flow
• Über Pull Requests beitragen

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 😊

Issues

Neues Issue erstellen

Wenn du ein Problem mit der Karte entdeckt hast, schau erstmal, ob nicht vielleicht bereits ein Issue dafür existiert. Falls nicht, kannst du gerne jederzeit ein neues Issue erstellen.

Issue lösen

Du kannst auch gerne durch unsere bestehenden 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 wird dich durch die Installation von GitHub Desktop führen.
  • Sobald GitHub Desktop eingerichtet ist, kannst du es zum forken des Repositories nutzen!

• mit der Kommandozeile:

  • Repository forken, 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.

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 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, sofern du eines löst.
• Setze den Haken bei "allow maintainer edits", 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! 😊
• Falls du beim Mergen Probleme bekommst, schau dir das folgende Git Tutorial an, um Merge-Konflikte und andere Probleme zu lösen.

Dein PR ist gemerged!

Herzliche Glückwünsche 🎉🎉 Das gesamte Team vom Queer Lexikon dankt dir! ✨