diff options
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 14 |
1 files changed, 13 insertions, 1 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0cae47e..b237ec1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -39,9 +39,21 @@ Falls du bereits mit Git vertraut bist, befolge die folgenden Schritte: ``` 3. Mache deine Änderungen lokal. 4. Committe deine Änderungen und push sie auf deinen Fork. -5. Erstelle einen neuen Pull Request für deine Änderungen. +5. Optional: Am besten prüfst du deine Änderungen ggf. kurz (s. unten). +6. Erstelle einen neuen Pull Request für deine Änderungen. +### Testing your changes + +Je nach Komplexität deiner Änderung kannst du dir diesen Schritt auch sparen. +Bei normalen Änderungen sollte es reichen, wenn du dir kurz über GitHub die +Vorschau anzeigen lässt (du kannst den GitHub flavored Markdown code natürlich +auch lokal, z. B. mit `Pandoc` rendern). Bei komplexeren Änderungen bietet es +sich an die GitHub Pages auf dem eigenen Fork zu aktivieren: Settings -> +GitHub Pages -> Source -> master branch -> Save. Nach ein paar Sekunden kannst +du deine Seite über https://yourname.github.io/skripte/ aufrufen. Alternativ +kannst du Jekyll auch lokal ausführen (advanced). + ### Continuous Integration Um zu überprüfen, dass alle Verlinkungen zumindest existieren, nutzten wir |