Mitmachen bei der Doku – So geht's ganz einfach!

Hallo zusammen! Wir freuen uns, dass ihr bei unserer Dokumentation mithelfen wollt. 😊 Hier ist eine einfache Anleitung, wie ihr das machen könnt:

Was du brauchst

1. GitHub-Konto:

   • Erstelle ein kostenloses GitHub-Konto, wenn du noch keins hast: https://github.com/join
   • Das brauchen wir, damit alles klappt.

2. GitHub Desktop:

   • Lade GitHub Desktop herunter und installiere es: https://desktop.github.com/
   • Das Programm macht die Arbeit mit Git einfacher, auch wenn du dich damit nicht so gut auskennst.

Los geht's!

1. Repository kopieren:

   • Gehe zu unserem Dokumentations-Bereich auf GitHub (z.B. nica-ev/docs) und klicke auf den Knopf "Fork".
   • Dadurch erstellst du eine eigene Kopie des Bereichs, in der du arbeiten kannst, ohne etwas kaputt zu machen. 😉

2. Repository auf deinen Computer holen:

   • Öffne GitHub Desktop.
   • Klicke auf "Datei" -> "Repository klonen...".
   • Wähle deine Kopie des Bereichs aus der Liste auf GitHub.
   • Suche einen Ordner auf deinem Computer aus, in dem du den Bereich speichern möchtest.
   • Klicke auf "Klonen".
   • Jetzt hast du eine Kopie des Bereichs auf deinem Computer.

3. (Optional) Einen neuen Arbeitsbereich erstellen:

   • Klicke in GitHub Desktop auf den Knopf "Aktueller Branch" (meistens links oben).
   • Gib einen neuen Namen für deinen Arbeitsbereich ein (z.B. neue-seite, fehler-korrigieren).
   • Klicke auf "Branch erstellen".
   • Arbeitsbereiche helfen, deine Änderungen zu trennen. Wenn etwas schiefgeht, kannst du den Arbeitsbereich einfach wieder löschen.
   • Merke: Das Erstellen eines neuen Arbeitsbereichs ist optional, aber es ist eine gute Idee, um deine Änderungen zu organisieren.

4. Änderungen machen:

   • Benutze dein Textprogramm (z.B. Notepad, VS Code), um die Dateien im Bereich auf deinem Computer zu bearbeiten.
   • Hier kannst du Texte hinzufügen, Fehler korrigieren und so weiter.
   • Wichtig: Benutze Markdown für die Formatierung (siehe unten).

5. Änderungen speichern:

   • In GitHub Desktop siehst du im Tab "Änderungen" deine geänderten Dateien.
   • Schreibe eine kurze Zusammenfassung in das Feld "Zusammenfassung".
   • Klicke auf "Commit zu <branch-name>" (oder "Commit zu main", wenn du keinen Arbeitsbereich verwendet hast).
   • Das Speichern ist wie ein Zwischenstand deiner Arbeit.

6. Änderungen hochladen:

   • Klicke in GitHub Desktop auf "Push origin".
   • Dadurch werden deine Änderungen in deine Kopie des Bereichs auf GitHub hochgeladen.

7. Änderungen zur Überprüfung einreichen:

   • Klicke in GitHub Desktop auf "Pull Request erstellen". Dann öffnet sich eine Seite auf GitHub.
   • Überprüfe dort deine Änderungen und klicke auf "Pull Request erstellen".
   • Ein Pull Request ist wie eine Anfrage, deine Änderungen in den Hauptbereich zu übernehmen.

Wichtig zu wissen

• Markdown: Ist wie eine einfache Sprache für Texte. Hier eine kurze Übersicht:
  • # Überschrift 1
  • ## Überschrift 2
  • **Fett**
  • *Kursiv*
  • - Liste
  • [Link](https://www.example.com)
• Nachrichten beim Speichern: Schreibe kurze Nachrichten zu deinen Speichervorgängen, damit jeder weiß, was du gemacht hast.
• Geduld: Am Anfang braucht es vielleicht ein bisschen Übung. Frag einfach, wenn etwas unklar ist!

Danke, dass du mithilfst! 🙌

---

Backlinks:

Mitmachen

Hier weiterlesen...

None

| github-for-users |

• Marc Bielert

|

• github
• tutorial

| 2025-01-23 05:45:14 |