From 7c9230330145a472124617b0ec8c407a91f1e656 Mon Sep 17 00:00:00 2001
From: Jo_field <150937665+JoField08@users.noreply.github.com>
Date: Thu, 16 Apr 2026 20:14:31 +0200
Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20docs(contribution):=20update=20c?=
=?UTF-8?q?ontribution=20guide=20and=20remove=20outdated=20sections?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
- rewrite contribution guide to provide clearer instructions for documentation contributions
- remove outdated topics related to documentation processes no longer in use
- add new sections for prerequisites and tools needed for contributions
---
Writerside/ccs.tree | 10 -
Writerside/redirection-rules.xml | 64 ++++
.../documentation/contribution.md | 275 +++++++++++++++++-
3 files changed, 337 insertions(+), 12 deletions(-)
diff --git a/Writerside/ccs.tree b/Writerside/ccs.tree
index 16fbd57e..744d310c 100644
--- a/Writerside/ccs.tree
+++ b/Writerside/ccs.tree
@@ -87,16 +87,6 @@
-
-
-
-
-
-
-
-
-
-
diff --git a/Writerside/redirection-rules.xml b/Writerside/redirection-rules.xml
index 78e60dd0..d1746bfa 100644
--- a/Writerside/redirection-rules.xml
+++ b/Writerside/redirection-rules.xml
@@ -197,4 +197,68 @@
Created after removal of "Shop verwalten" from Community Server Docs
shop-myshop.html
+
+ Created after removal of "Repository anlegen" from Community Server Docs
+ fork-repo.html
+
+
+ Created after removal of "WriterSide Installieren" from Community Server Docs
+ install-writerside.html
+
+
+ Created after removal of "Dokumentation schreiben" from Community Server Docs
+ write-documentation.html
+
+
+ Created after removal of "Markdown in WriterSide verwenden" from Community Server Docs
+
+ function-overviews.html
+
+
+
+
+ update-project.html
+
+
+ Created after removal of "Änderungen Veröffentlichen" from Community Server Docs
+ publish-changes.html
+
+
+ Created after removal of "Merge Request erstellen" from Community Server Docs
+ create-merge-request.html
+
+
+ Created after removal of "Markdown in WriterSide verwenden" from Community Server Docs
+
+ function-overviews.html
+
+
+ Created after removal of "Dokumentation Contribution" from Community Server Docs
+ doc-contribution.html
+
+
+ Created after removal of "Repository anlegen" from Community Server Docs
+ fork-repo.html
+
+
+ Created after removal of "WriterSide Installieren" from Community Server Docs
+ install-writerside.html
+
+
+ Created after removal of "Dokumentation schreiben" from Community Server Docs
+ write-documentation.html
+
+
+
+
+ update-project.html
+
+
+ Created after removal of "Änderungen Veröffentlichen" from Community Server Docs
+ publish-changes.html
+
+
+ Created after removal of "Merge Request erstellen" from Community Server Docs
+ create-merge-request.html
+
\ No newline at end of file
diff --git a/Writerside/topics/contribution/documentation/contribution.md b/Writerside/topics/contribution/documentation/contribution.md
index ffab673e..499be8a0 100644
--- a/Writerside/topics/contribution/documentation/contribution.md
+++ b/Writerside/topics/contribution/documentation/contribution.md
@@ -1,3 +1,274 @@
-# Contribution
+# Dokumentation Contribution Guide
-Wie du zu dieser Dokumentation beitragen kannst, erfährst du [hier](doc-contribution.md)
+Willkommen beim Leitfaden für die Mitarbeit an unserer Dokumentation.\
+In diesem Dokument erfährst du, wie du mithilfe von **IntelliJ**, **Writerside** und **GitHub** neue Inhalte erstellst
+und bestehende überarbeiten kannst.
+
+## Voraussetzungen
+
+Bevor du beginnst, stelle sicher, dass du über Folgendes verfügst:
+
+- Einen [GitHub Account](https://github.com)
+- [JetBrains IntelliJ IDEA](https://www.jetbrains.com/de-de/writerside/download/) (installiert und startbereit)
+- Grundkenntnisse im Umgang mit Markdown und Git
+
+> Eine saubere, fehlerfreie und übersichtliche Schreibweise ist die Grundvoraussetzung für die Annahme deiner
+> Änderungen.
+>
+{style="note" title="Hinweis"}
+
+## 1. Benötigte Plugins installieren {collapsible="true"}
+
+Wenn du bereits IntelliJ IDEA nutzt, musst du keine separate IDE installieren. Writerside kann einfach als Plugin
+hinzugefügt werden.
+Damit Commits und Pull Requests automatisch korrekt formatiert werden, benötigst du zusätzlich das Plugin Conventional
+Commit.
+
+
+
+Öffne IntelliJ IDEA.
+
+
+
+Klicke links unten in der Ecke auf das Zahnrad und Wähle `Settings` aus.
+
+
+
+Klicke im Einstellungsfenster auf `Plugins`.
+
+
+Stelle sicher, dass der Reiter Marketplace ausgewählt ist, und suche nach Writerside.
+
+
+
+Klicke auf `Install` neben dem Writerside Plugin.
+
+
+Anschließend muss die IDE neugestartet werden.
+
+
+Nach dem Neustart ist das Plugin installiert und es befindet sich das Writerside Tool Window am linken Rand in geöffneten Projekte.
+
+
+
+
+
+Öffne IntelliJ IDEA.
+
+
+
+Klicke links unten in der Ecke auf das Zahnrad und Wähle `Settings` aus.
+
+
+
+Klicke im Einstellungs-Fenster auf `Plugins`.
+
+
+Stelle sicher, dass der Reiter Marketplace ausgewählt ist, und suche nach Conventional Commit.
+
+
+
+Klicke auf `Install` neben dem Writerside Plugin.
+
+
+Anschließend muss die IDE neugestartet werden.
+
+
+Nach dem Neustart ist das Plugin installiert.
+
+
+
+## 1. Repository vorbereiten {collapsible="true"}
+
+Damit du Änderungen einreichen kannst, arbeitest du in einer eigenen Kopie des Projekts. Dies nennt man **Fork**.
+
+
+
+Gehe auf die GitHub Seite der Dokumentation.
+
+
+Stelle sicher, dass du in GitHub mit deinem Account angemeldet bist.
+
+
+Klicke oben rechts auf den Knopf Fork.
+
+
+
+Klicke auf Create Fork. Nun hast du eine Kopie des Projekts in deinem eigenen GitHub-Account.
+
+
+
+
+
+Öffne IntelliJ IDEA und wähle Get from VCS.
+
+
+Füge die URL deines geforkten Repositories ein und klicke auf Clone.
+
+
+
+Das Projekt wird anschließend geöffnet und geladen.
+
+
+
+## 2. Neuen Branch anlegen {collapsible="true"}
+
+Arbeite für jede Änderung in einem eigenen Branch, um die Übersicht zu behalten und Konflikte und Chaos zu vermeiden.
+
+
+
+Klicke oben links auf den aktuellen Branch-Namen (meist main oder master).
+
+
+Wähle + New Branch aus. Nutze für den Namen ein Präfix, um die Art deiner Änderung direkt zu kennzeichnen.
+
+| Präfix | Beschreibung | Beispiel |
+|:------------|:------------------------------------------|:----------------------------------|
+| `feat/` | Für neue Funktionen oder Features | `feat/new-login-system` |
+| `fix/` | Für Fehlerbehebungen (Bugfixes) | `fix/button-click-issue` |
+| `ver/` | Für Versionierung und Releases | `ver/1.0.0` |
+| `dev/` | Für Entwicklungszwecke und Experimente | `dev/experimental-feature` |
+| `chore/` | Für Routineaufgaben und Wartung | `chore/update-dependencies` |
+| `refactor/` | Code-Refactorings ohne Funktionsänderung | `refactor/improve-modularization` |
+| `test/` | Für Änderungen an Tests | `test/add-new-unit-tests` |
+| `hotfix/` | Dringende Korrekturen (Sofort-Deployment) | `hotfix/security-patch` |
+| `docs/` | Für Änderungen an der Dokumentation | `docs/update-readme` |
+| `perf/` | Für Performance-Verbesserungen | `perf/optimize-query-performance` |
+| `style/` | Für Code-Stil und Formatierungsänderungen | `style/fix-indentation` |
+| `opt/` | Für allgemeine Optimierungsaufgaben | `opt/7-optimize-packet-operation` |
+
+
+
+
+Es wird nun ein neuer Branch mit dem angegebenen namen erstellt. In diesem arbeitest du nun weiter.
+
+
+> Achte darauf, dass du dich **vor dem Erstellen des Branches** auf dem aktuellen Stand des `master`-Branches befindest,
+> um spätere Konflikte zu vermeiden.
+>
+{style="warning" title="Wichtig"}
+
+
+
+## 3. Dokumentation bearbeiten {collapsible="true"}
+
+Wenn du einen neuen Branch erstellt hast, kannst du nun die Dokumentation bearbeiten und beispielsweise eine neue Seiten
+einfügen.
+
+
+
+
+Öffne das Writerside Tool Window (links am Rand) und klicke auf `+` und wähle `Empty MD Topic`.
+
+
+Verwende für den Dateinamen Kleinschreibung, Englisch und Bindestriche (z. B. setup-guide.md).
+Der Anzeigename ist frei wählbar.
+
+
+
+Bestätige die Abfrage "Add file to Git" mit `Add`.
+
+
+Ziehe die neue Datei im Projekt-Explorer in den entsprechenden Unterordner innerhalb Verzeichnisses.#
+
+
+
+Die neue Seite wurde erfolgreich erstellt und kann nun bearbeitet werden.
+
+
+
+## 4. Mardown Grundlagen {collapsible="true"}
+
+
+
+
+ Verwende **Text**, um wichtige Begriffe hervorzuheben.
+ Beispiel: Dieser Text ist fettgedruckt
+
+
+ Verwende *Text* für dezente Betonungen.
+ Beispiel: Dieser Text ist kursiv
+
+
+ Verwende ~~Text~~, um veraltete Infos zu markieren.
+ Beispiel: Dieser Text ist durchgestrichen
+
+
+ Nutze [Text](URL) für Verweise.
+ Beispiel: Google
+
+
+ Nutze einzelne Backticks (`code`) für Befehle oder Variablennamen im fließenden Text.
+ Beispiel: Für jede aktive Spielstunde erhältst du %paycheck% %main_currency%s.
+
+
+ Für mehrzeiligen Code verwende dreifache Backticks (``` code ```) mit Angabe der Sprache:
+
+ java
+ public void hello() {
+ System.out.println("Hello World");
+ }
+
+
+
+ Nutze  um Bilder einzufügen.
+Bilder müssen zwingend im Ordner images liegen, damit sie im Build korrekt angezeigt werden.
+
+
+
+> Es gibt noch viel mehr Formatierungen, die du verwenden kannst. Eine vollständige Dokumentation dazu findest du
+> direkt auf der [WriterSide Dokumentation](https://www.jetbrains.com/help/writerside/markup-reference.html). \
+> Dort wird unter anderem erklärt, wie du Tabellen, Listen, Überschriften und mehr erstellen kannst.
+>
+{style="note"}
+
+Das waren einige grundlegende Markdown-Formatierungsanweisungen, die du in WriterSide verwenden kannst. Du kannst diese
+Formatierungen kombinieren, um deinen Text nach deinen Vorstellungen zu gestalten.
+
+## 5. Änderungen veröffentlichen {collapsible="true"}
+
+Sobald deine Texte fertig sind, müssen sie über Git gespeichert und hochgeladen werden, damit sie für andere sichtbar werden.
+
+
+
+ Commit-Fenster öffnen: Klicke links am Rand auf das Commit-Icon oder drücke Strg + K.
+ 
+
+
+ Dateien wählen: Markiere alle Dateien, die du geändert oder neu erstellt hast.
+
+
+ Commit-Nachricht erstellen: Klicke auf das Icon Build Commit Message (Conventional Commit Plugin), um den Dialog zu öffnen.
+ 
+
+
+ Details ausfüllen: Fülle die Felder im Pop-up wie folgt aus:
+
+ Type: Art der Änderung (z. B. feat für neue Inhalte, fix für Korrekturen).
+ Scope: Der betroffene Bereich (z. B. docs).
+ Subject: Eine kurze, prägnante Zusammenfassung auf Englisch.
+ Body: (Optional) Eine detailliertere Beschreibung der Änderungen.
+
+
+
+ Absenden: Klicke unten auf den Pfeil neben Commit und wähle Commit and Push.... Bestätige den anschließenden Dialog mit Push.
+ 
+
+
+
+
+
+ Gehe auf GitHub zur Seite deines geforkten Repositories.
+
+
+ Klicke auf den Button Contribute und wähle Open pull request.
+ Vergewissere dich, dass oben der richtige Branch ausgewählt ist, in dem du gearbeitet hast.
+ 
+
+
+ Titel und Beschreibung: Gib deinem PR einen aussagekräftigen Namen und beschreibe kurz, was geändert wurde. Klicke dann auf Create pull request.
+
+
+ Review abwarten: Dein Beitrag wird nun vom Team geprüft. Falls es Anmerkungen gibt, kannst du diese einfach in deinem lokalen Projekt korrigieren und erneut pushen – der PR aktualisiert sich automatisch.
+
+
\ No newline at end of file