-
Notifications
You must be signed in to change notification settings - Fork 13
feat(docs): enhance contribution guidelines and add external develope… #297
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.
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
Changes from all commits
ca3605a
d5194d7
b359ef4
8d52977
ac89b04
c03f475
0c6f67b
ed1488f
8c90375
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -1,3 +1,15 @@ | ||||||
| # Contribution | ||||||
|
|
||||||
| Wie du zu dieser Dokumentation beitragen kannst, erfährst du [hier](doc-contribution.md) | ||||||
| Unser Community-Server besteht mittlerweile aus vielen spannenden Bereichen, zahlreichen Features und technischen | ||||||
| Projekten, die für eine bessere Spieler- und Nutzererfahrung sorgen. | ||||||
| Wir arbeiten kontinuierlich an neuen Features, Verbesserungen und coolen Tools. | ||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
| Da wir immer weiter wachsen und neue Ideen umsetzen möchten, brauchen wir Unterstützung von engagierten Spielern. | ||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
| Wir suchen sowohl erfahrene Entwickler als auch Anfänger, die motiviert sind, sich selbständig in neue Themen einzuarbeiten. | ||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
| Es gibt sowohl komplexe Projekte für Fortgeschrittene als auch kleinere Aufgaben, die sich ideal für den Einstieg | ||||||
| eignen. | ||||||
| Wie du uns aktiv dabei helfen kannst den Server weiterzuentwickeln und zu verbwessern, erfährst du in deiesm Abschnitt. | ||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
|
||||||
| > Mach mit und werde Teil unseres Projekts – jede Idee zählt! \ | ||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
| > Wir freuen uns auf deinen Beitrag! | ||||||
| > | ||||||
| {style="note"} | ||||||
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -2,11 +2,11 @@ | |||||
|
|
||||||
| ## Voraussetzungen | ||||||
|
|
||||||
| - einen [Github Account](https://github.com) | ||||||
| - [WriterSide](https://www.jetbrains.com/de-de/writerside/download/#section=windows) | ||||||
| - Ihr habt einen [Github Account](https://github.com) | ||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
| - [WriterSide](https://plugins.jetbrains.com/plugin/20158-writerside) | ||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
| - Erstellen von Pull und Merge Requests | ||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
| - Fehlerfrei, übersichtlich und verständlich schreiben können | ||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
|
||||||
| > Eine grobe Übersicht findet ihr in den folgenden Abschnitten. | ||||||
| > | ||||||
| {style="note"} | ||||||
| Original file line number | Diff line number | Diff line change | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -1,39 +1,52 @@ | ||||||||||||
| # WriterSide Installieren | ||||||||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||
|
|
||||||||||||
|
|
||||||||||||
| Writerside ist ein JetBrains-IDE, das auf der IntelliJ-Plattform basiert. Mit Writerside kannst du einfach und schnell | ||||||||||||
| Writerside ist ein Plugin für die JetBrains-IDE, das auf der IntelliJ-Plattform basiert. Mit Writerside kannst du | ||||||||||||
| einfach und schnell | ||||||||||||
| Dokumentationen schreiben. | ||||||||||||
|
Comment on lines
+3
to
5
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||
|
|
||||||||||||
| <procedure title="Installation" id="install"> | ||||||||||||
| <procedure title="Writerside in IntelliJ IDEA" id="install-writerside-in-intellij"> | ||||||||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||
| <step> | ||||||||||||
| Lade dir die neuste Version von Writerside | ||||||||||||
| <a href="https://www.jetbrains.com/de-de/writerside/download/" summary="WriterSide Download">hier</a> | ||||||||||||
| herunter. | ||||||||||||
|
|
||||||||||||
| Lade dir die neuste Version der [IntelliJ IDEA](https://www.jetbrains.com/de-de/idea/download/) herunter. | ||||||||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||
| </step> | ||||||||||||
| <step> | ||||||||||||
| Führe die heruntergeladene Datei aus und folge den Anweisungen des Installers. | ||||||||||||
| </step> | ||||||||||||
| <step> | ||||||||||||
| Installiere das Plugin | ||||||||||||
| <a href="https://plugins.jetbrains.com/plugin/13389-conventional-commit">Conventional Commit</a> | ||||||||||||
| <img src="install-writerside-first.png" alt="Conventional Commit installieren" style="block" thumbnail="true"/> | ||||||||||||
| Öffne IntelliJ IDEA und navigiere über das Zahnrad in der Rechten Ecke auf Plugins. | ||||||||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||
| </step> | ||||||||||||
| <step> | ||||||||||||
|
|
||||||||||||
| Installiere das Plugin [Writerside](https://www.jetbrains.com/de-de/idea/download/). | ||||||||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||
|  {border-effect="rounded" thumbnail="true"} | ||||||||||||
| </step> | ||||||||||||
| <step> | ||||||||||||
|
|
||||||||||||
| Installiere das Plugin [Conventional Commit](https://plugins.jetbrains.com/plugin/13389-conventional-commit). | ||||||||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||
| </step> | ||||||||||||
| <step> | ||||||||||||
| Starte WriterSide neu um das Plugin zu aktivieren. | ||||||||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||
| Klicke dazu einfach auf <code>Restart IDE</code> wo vorher <code>Install</code> stand. | ||||||||||||
| </step> | ||||||||||||
|
|
||||||||||||
| > Du hast Writerside nun erfolgreis installiert | ||||||||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||
| > | ||||||||||||
| {style="note"} | ||||||||||||
|
|
||||||||||||
| </procedure> | ||||||||||||
| <procedure title="Kopie der Dokumentation öffnen"> | ||||||||||||
| <step> | ||||||||||||
| Öffne WriterSide und klicke auf <code>Get from VCS</code>. | ||||||||||||
| Füge dann den Link zu dem Git-Repository ein was du im vorherigen Schritt geforkt hast | ||||||||||||
| (siehe <a href="fork-repo.md" anchor="fork">hier</a>) und drücke auf <code>Clone</code>. | ||||||||||||
| <img src="install-writerside-second.png" alt="Get from VCS" style="block" thumbnail="true"/> | ||||||||||||
|
|
||||||||||||
| Öffne IntelliJ und klicke auf `Get from VCS`. | ||||||||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||
| Füge dann den Link zu dem Git-Repository ein was du [im vorherigen Schritt geforkt](fork-repo.md) hast und drücke | ||||||||||||
| auf `Clone`. | ||||||||||||
|
Comment on lines
+40
to
+41
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||
| {border-effect="rounded" thumbnail="true"} | ||||||||||||
| </step> | ||||||||||||
| <step> | ||||||||||||
|
|
||||||||||||
| Jetzt musst du noch bestätigen, dass du dem Projekt vertraust. | ||||||||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||
| <img src="install-writerside-third.png" alt="Trust Project" style="block" thumbnail="true"/> | ||||||||||||
| {border-effect="rounded" thumbnail="true"} | ||||||||||||
| </step> | ||||||||||||
| </procedure> | ||||||||||||
|
|
||||||||||||
| <seealso> | ||||||||||||
| <category ref="spotlight"> | ||||||||||||
| <a href="write-documentation.md"/> | ||||||||||||
|
|
||||||||||||
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,23 @@ | ||||||
| # Externer Entwickler | ||||||
|
|
||||||
| <deflist> | ||||||
| <def title="Beschreibung" id="description-external-developer"> | ||||||
|
|
||||||
| Unser Server besteht aus vielen spannenden technischen Projekten, die für eine bessere Spieler- und Nutzererfahrung sorgen. | ||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
| Wir arbeiten kontinuierlich an neuen Funktionen und Verbesserungen. | ||||||
| Da wir immer weiter wachsen und neue Ideen umsetzen möchten, brauchen wir Unterstützung von engagierten Entwicklern! | ||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
| Viele unserer Funktionen & Plugins sind [öffentlich auf GitHub](https://github.com/SLNE-Development) zugänglich. | ||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
| An diesen könnt ihr, als externe Entwickler aktiv mitarbeiten! | ||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
| Wir suchen sowohl erfahrene Entwickler als auch Anfänger, die motiviert sind, sich in neue Themen einzuarbeiten. | ||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
| Es gibt sowohl komplexe Projekte für Fortgeschrittene als auch kleinere Aufgaben, die sich ideal für den Einstieg eignen. | ||||||
| Durch die Zusammenarbeit mit dem Team und das Mitwirken an den Projekten bietet sich eine wertvolle Gelegenheit, technische Fähigkeiten zu erweitern und neue Technologien zu erlernen. | ||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
|
||||||
| </def> | ||||||
| <def title="Anforderungen" id="requirements-external-developer"> | ||||||
|
|
||||||
| - Du erlernst selbstständig die Fähigkeiten, die du für die Projekte benötigst | ||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
| - Du hast Erfahrungen mit [GitHub](https://github.com) | ||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
| - **Weitere Informationen findest du im [Discord](https://discord.com/channels/133198459531558912/1342425538014482453/1342443811615408202)** | ||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. What channel is this? If it was the dev application channel, it has been deleted. |
||||||
|
|
||||||
| </def> | ||||||
| </deflist> | ||||||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.