-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
6 changed files
with
59 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
57 changes: 57 additions & 0 deletions
57
...eitfaden-Branch-Erstellung-und-Bearbeitung-in-der-ProjektAdLer-Dokumentation.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,57 @@ | ||
# Technischer Leitfaden: Branch-Erstellung und Bearbeitung in der ProjektAdLer Dokumentation | ||
|
||
## 0. Das Projekt Clonen | ||
Dazu Writersiede starten und ein neues Projekt aus Git clonen. | ||
|
||
Das Repo ist unter folgendem Link zu finden: | ||
|
||
https://github.com/ProjektAdLer/Documentation | ||
|
||
![Clonen.png](Clonen.png) | ||
|
||
## 1. Eigenen Branch erstellen | ||
|
||
1. Das ProjektAdLer Dokumentations-Projekt in JetBrains Writerside öffnen. | ||
2. In der oberen Menüleiste auf den aktuellen Branch-Namen klicken (im Screenshot ist "main" ausgewählt). | ||
3. Im Dropdown-Menü "New Branch..." auswählen. Alternativ kann die Tastenkombination Strg+Alt+N verwendet werden. | ||
4. Im sich öffnenden Dialogfeld den neuen Branch nach dem Schema benennen: `KorrekturXX1207` | ||
- XX steht für das Personenkürzel | ||
- 1207 ist das aktuelle Datum (z.B. 12. Juli) | ||
5. Die Erstellung des neuen Branches bestätigen. | ||
|
||
![neuerBRanch.png](neuerBRanch.png) | ||
|
||
## 2. Topics finden und lesen | ||
|
||
1. Im Projekt-Explorer zum Ordner mit den Topics navigieren | ||
2. Die relevanten Topic-Dateien durch Doppelklick öffnen. | ||
|
||
![WriterSide_Overview](WriterSide_Overview.png) | ||
|
||
## 3. Änderungen und Kommentare einfügen | ||
|
||
1. Den Inhalt der Topic-Datei lesen. | ||
2. Für Änderungen: | ||
- Den Text direkt im Editor korrigieren. (Die änderungen werden von Git hervorgehoben. Das müsst ihr nicht extra markieren) | ||
3. Für Kommentare: | ||
- Einen Kommentar im folgenden Format einfügen: | ||
``` | ||
[//]: # (TODO: XX: Rechtschreibfehler entfernen) | ||
``` | ||
- "XX" durch das Personenkürzel ersetzen. | ||
- Wenn ihr diese mit TODO: beginnt, werden sie in der Writerside als Aufgaben angezeigt. | ||
## 4. Änderungen committen | ||
1. Das Git-Fenster öffnen (Roter pfeil auf dem Bild). | ||
2. Die geänderten Dateien auswählen. | ||
**Wichtig: Es muss der eigene Branch ausgewählt sein. (Auf dem Screenshot der Rote Kreis)** | ||
3. Eine aussagekräftige Commit-Nachricht eingeben. | ||
4. Auf "Commit and Push" klicken. Somit werden die Änderungen auf den eigenen Branch auf GitHub hochgeladen. | ||
5. Eventuell wird nach dem GitHub-Passwort gefragt. Dabei mit den GitHub Zugangsdaten anmelden, welche auch in der AdLer Organisation verwendet werden. | ||
![Writerside_Commit.png](Writerside_Commit.png) | ||
## 5. Pull Request auf GitHub erstellen | ||
Diesen Schritt werden die Entwickler dann übernehmen |