Skip to content

Fix/contribution #366

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
JoField08 wants to merge 3 commits into
base: master
Choose a base branch
from
Draft

Fix/contribution #366

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
70c6477
Merge remote-tracking branch 'origin/master'
JoField08 Apr 16, 2026
71f822a
Merge remote-tracking branch 'origin/master'
JoField08 Apr 16, 2026
7c92303
📝 docs(contribution): update contribution guide and remove outdated s…
JoField08 Apr 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 0 additions & 10 deletions Writerside/ccs.tree
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,16 +87,6 @@
<toc-element topic="clan-more-info.md"/>
</toc-element>
<toc-element topic="contribution.md">
<toc-element topic="doc-contribution.md">
<toc-element topic="fork-repo.md"/>
<toc-element topic="install-writerside.md"/>
<toc-element topic="write-documentation.md">
<toc-element topic="function-overviews.md"/>
</toc-element>
<toc-element topic="update-project.md"/>
<toc-element topic="publish-changes.md"/>
<toc-element topic="create-merge-request.md"/>
</toc-element>
</toc-element>
<toc-element topic="support.md"/>
<toc-element topic="rank-overview.topic">
Expand Down
64 changes: 64 additions & 0 deletions Writerside/redirection-rules.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -197,4 +197,68 @@
<description>Created after removal of "Shop verwalten" from Community Server Docs</description>
<accepts>shop-myshop.html</accepts>
</rule>
<rule id="55e96dbc">
<description>Created after removal of "Repository anlegen" from Community Server Docs</description>
<accepts>fork-repo.html</accepts>
</rule>
<rule id="1341733a">
<description>Created after removal of "WriterSide Installieren" from Community Server Docs</description>
<accepts>install-writerside.html</accepts>
</rule>
<rule id="7f909ab7">
<description>Created after removal of "Dokumentation schreiben" from Community Server Docs</description>
<accepts>write-documentation.html</accepts>
</rule>
<rule id="56c687f0">
<description>Created after removal of "Markdown in WriterSide verwenden" from Community Server Docs
</description>
<accepts>function-overviews.html</accepts>
</rule>
<rule id="4d33e987">
<description>
<![CDATA[Created after removal of "Projekt & Fork Updaten" from Community Server Docs]]></description>
<accepts>update-project.html</accepts>
</rule>
<rule id="11441a35">
<description>Created after removal of "Änderungen Veröffentlichen" from Community Server Docs</description>
<accepts>publish-changes.html</accepts>
</rule>
<rule id="5613633c">
<description>Created after removal of "Merge Request erstellen" from Community Server Docs</description>
<accepts>create-merge-request.html</accepts>
</rule>
<rule id="79fbfb6b">
<description>Created after removal of "Markdown in WriterSide verwenden" from Community Server Docs
</description>
<accepts>function-overviews.html</accepts>
</rule>
<rule id="45f3ef57">
<description>Created after removal of "Dokumentation Contribution" from Community Server Docs</description>
<accepts>doc-contribution.html</accepts>
</rule>
<rule id="1672ff95">
<description>Created after removal of "Repository anlegen" from Community Server Docs</description>
<accepts>fork-repo.html</accepts>
</rule>
<rule id="1c6c53b6">
<description>Created after removal of "WriterSide Installieren" from Community Server Docs</description>
<accepts>install-writerside.html</accepts>
</rule>
<rule id="18650fe4">
<description>Created after removal of "Dokumentation schreiben" from Community Server Docs</description>
<accepts>write-documentation.html</accepts>
</rule>
<rule id="166fddac">
<description>
<![CDATA[Created after removal of "Projekt & Fork Updaten" from Community Server Docs]]></description>
<accepts>update-project.html</accepts>
</rule>
<rule id="378c2000">
<description>Created after removal of "Änderungen Veröffentlichen" from Community Server Docs</description>
<accepts>publish-changes.html</accepts>
</rule>
<rule id="27a5507a">
<description>Created after removal of "Merge Request erstellen" from Community Server Docs</description>
<accepts>create-merge-request.html</accepts>
</rule>
</rules>
275 changes: 273 additions & 2 deletions Writerside/topics/contribution/documentation/contribution.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.

<procedure title="Writerside Plugin installieren" id="install-plugin-writerside">
<step>
Öffne IntelliJ IDEA.
</step>
<step>

Klicke links unten in der Ecke auf das Zahnrad und Wähle `Settings` aus.
</step>
<step>

Klicke im Einstellungsfenster auf `Plugins`.
</step>
<step>
Stelle sicher, dass der Reiter <code>Marketplace</code> ausgewählt ist, und suche nach <code>Writerside</code>.
</step>
<step>

Klicke auf `Install` neben dem Writerside Plugin.
</step>
<step>
Anschließend muss die IDE neugestartet werden.
</step>
<step>
Nach dem Neustart ist das Plugin installiert und es befindet sich das <b>Writerside Tool Window</b> am linken Rand in geöffneten Projekte.
</step>
</procedure>

<procedure title="Conventional Commit Plugin installieren" id="install-plugin-conventional-commit">
<step>
Öffne IntelliJ IDEA.
</step>
<step>

Klicke links unten in der Ecke auf das Zahnrad und Wähle `Settings` aus.
</step>
<step>

Klicke im Einstellungs-Fenster auf `Plugins`.
</step>
<step>
Stelle sicher, dass der Reiter <code>Marketplace</code> ausgewählt ist, und suche nach <code>Conventional Commit</code>.
</step>
<step>

Klicke auf `Install` neben dem Writerside Plugin.
</step>
<step>
Anschließend muss die IDE neugestartet werden.
</step>
<step>
Nach dem Neustart ist das Plugin installiert.
</step>
</procedure>

## 1. Repository vorbereiten {collapsible="true"}

Damit du Änderungen einreichen kannst, arbeitest du in einer eigenen Kopie des Projekts. Dies nennt man **Fork**.

<procedure title="Repository forken" id="repo-fork">
<step>
Gehe auf die <a href="%git-repo-link%">GitHub Seite der Dokumentation</a>.
</step>
<step>
Stelle sicher, dass du in GitHub mit deinem Account angemeldet bist.
</step>
<step>
Klicke oben rechts auf den Knopf <code>Fork</code>.
<img src="fork-repo-first.png" alt="Fork Repository" style="block" thumbnail="true"/>
</step>
<step>
Klicke auf <code>Create Fork</code>. Nun hast du eine Kopie des Projekts in deinem eigenen GitHub-Account.
</step>
</procedure>

<procedure title="Repository clonen &amp; Projekt öffnen" id="repo-clone">
<step>
Öffne IntelliJ IDEA und wähle <code>Get from VCS</code>.
</step>
<step>
Füge die URL <b>deines geforkten Repositories</b> ein und klicke auf <code>Clone</code>.
<img src="install-writerside-second.png" alt="Get from VCS" style="block" thumbnail="true"/>
</step>
<step>
Das Projekt wird anschließend geöffnet und geladen.
</step>
</procedure>

## 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.

<procedure title="Neuen Branch erstellen" id="create-branch">
<step>
Klicke oben links auf den aktuellen Branch-Namen (meist <code>main</code> oder <code>master</code>).
</step>
<step>
Wähle <code>+ New Branch</code> 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` |

</step>

<step>
Es wird nun ein neuer Branch mit dem angegebenen namen erstellt. In diesem arbeitest du nun weiter.
</step>

> 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"}

</procedure>

## 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.

<procedure title="Neue Seite anlegen" id="create-page">
<step>

Öffne das Writerside Tool Window (links am Rand) und klicke auf `+` und wähle `Empty MD Topic`.
</step>
<step>
Verwende für den Dateinamen Kleinschreibung, Englisch und Bindestriche (z. B. setup-guide.md).
Der Anzeigename ist frei wählbar.
</step>
<step>

Bestätige die Abfrage "Add file to Git" mit `Add`.
</step>
<step>
Ziehe die neue Datei im Projekt-Explorer in den entsprechenden Unterordner innerhalb Verzeichnisses.#
<img src="write-documentation-seventh.gif" alt="Move File" thumbnail="true"/>
</step>
<step>
Die neue Seite wurde erfolgreich erstellt und kann nun bearbeitet werden.
</step>
</procedure>

## 4. Mardown Grundlagen {collapsible="true"}

<deflist>

<def title="Fett" id="bold">
Verwende <code>**Text**</code>, um wichtige Begriffe hervorzuheben. <br/>
Beispiel: <b>Dieser Text ist fettgedruckt</b>
</def>
<def title="Kursiv" id="italic">
Verwende <code>*Text*</code> für dezente Betonungen. <br/>
Beispiel: <i>Dieser Text ist kursiv</i>
</def>
<def title="Durchgestrichen" id="strikethrough">
Verwende <code>~~Text~~</code>, um veraltete Infos zu markieren. <br/>
Beispiel: <strike>Dieser Text ist durchgestrichen</strike>
</def>
<def title="Links" id="links">
Nutze <code>[Text](URL)</code> für Verweise. <br/>
Beispiel: <a href="https://www.google.com">Google</a>
</def>
<def title="Code" id="code">
Nutze einzelne Backticks (<code>`code`</code>) für Befehle oder Variablennamen im fließenden Text.
Beispiel: Für jede aktive Spielstunde erhältst du <code>%paycheck% %main_currency%s</code>.
</def>
<def title="Codeblöcke" id="code-blocks">
Für mehrzeiligen Code verwende dreifache Backticks (<code>``` code ```</code>) mit Angabe der Sprache:
<code-block>
java
public void hello() {
System.out.println("Hello World");
}
</code-block>
</def>
<def title="Bilder" id="images">
Nutze <code>![Alternativer Text](dateiname.png)</code> um Bilder einzufügen. <br/>
<note>Bilder müssen zwingend im Ordner <code>images</code> liegen, damit sie im Build korrekt angezeigt werden.</note>
</def>
</deflist>

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

<procedure title="Committen und Pushen" id="publish-changes">
<step>
<b>Commit-Fenster öffnen:</b> Klicke links am Rand auf das <code>Commit</code>-Icon oder drücke <code>Strg + K</code>.
<img src="publish-changes-first.png" alt="Commit Fenster" style="block"/>
</step>
<step>
<b>Dateien wählen:</b> Markiere alle Dateien, die du geändert oder neu erstellt hast.
</step>
<step>
<b>Commit-Nachricht erstellen:</b> Klicke auf das Icon <code>Build Commit Message</code> (Conventional Commit Plugin), um den Dialog zu öffnen.
<img src="publish-changes-third.png" alt="Build Commit Message" style="block" thumbnail="true"/>
</step>
<step>
<b>Details ausfüllen:</b> Fülle die Felder im Pop-up wie folgt aus:
<list style="bullet">
<li><b>Type:</b> Art der Änderung (z. B. <code>feat</code> für neue Inhalte, <code>fix</code> für Korrekturen).</li>
<li><b>Scope:</b> Der betroffene Bereich (z. B. <code>docs</code>).</li>
<li><b>Subject:</b> Eine kurze, prägnante Zusammenfassung auf Englisch.</li>
<li><b>Body:</b> (Optional) Eine detailliertere Beschreibung der Änderungen.</li>
</list>
</step>
<step>
<b>Absenden:</b> Klicke unten auf den Pfeil neben <code>Commit</code> und wähle <code>Commit and Push...</code>. Bestätige den anschließenden Dialog mit <code>Push</code>.
<img src="publish-changes-fifth.png" alt="Commit and Push" style="block" thumbnail="true"/>
</step>
</procedure>

<procedure title="Pull Request auf GitHub erstellen" id="create-pr">
<step>
Gehe auf GitHub zur Seite <b>deines</b> geforkten Repositories.
</step>
<step>
Klicke auf den Button <code>Contribute</code> und wähle <code>Open pull request</code>.
<note>Vergewissere dich, dass oben der richtige Branch ausgewählt ist, in dem du gearbeitet hast.</note>
<img src="open-pull-request.png" alt="Pull Request öffnen" style="block" thumbnail="true"/>
</step>
<step>
<b>Titel und Beschreibung:</b> Gib deinem PR einen aussagekräftigen Namen und beschreibe kurz, was geändert wurde. Klicke dann auf <code>Create pull request</code>.
</step>
<step>
<b>Review abwarten:</b> 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.
</step>
</procedure>
Loading