diff options
| -rw-r--r-- | .travis.yml | 4 | ||||
| -rw-r--r-- | CONTRIBUTING.md | 16 | ||||
| -rw-r--r-- | Gemfile | 3 | ||||
| -rw-r--r-- | _config.yml | 5 |
4 files changed, 25 insertions, 3 deletions
diff --git a/.travis.yml b/.travis.yml index 2579a6b..35eec4b 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,6 +1,10 @@ language: ruby rvm: - 2.3.3 +addons: + apt: + packages: + - libcurl4-openssl-dev # Required to avoid TLS errors script: - set -e # halt script on error diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0cae47e..bc5f574 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,7 +8,7 @@ Wir freuen uns, dass du dir überlegst, dich an diesem Repository zu beteiligen. Zunächst solltest du wissen, dass du, wenn du zu diesem Repository beitragen möchtest, unseren -[Lizenzbestimmungen](https://github.com/fsi-tue/skripte/blob/master/LICENSE) +[Lizenzbestimmungen](/LICENSE.txt) zustimmen musst. Wir verwenden in diesem Repository eine [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/) Lizenz, was bedeutet, dass du den Inhalt beliebig teilen und verändern kannst unter der Bedingung, @@ -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 @@ -4,6 +4,9 @@ ruby RUBY_VERSION # This is the gem used to use GitHub's defaults gem 'github-pages', group: :jekyll_plugins +# For GitHub flavored emoji support +gem 'jemoji' + # This is the gem used to test the output html gem "html-proofer" diff --git a/_config.yml b/_config.yml index 2f7efbe..717f378 100644 --- a/_config.yml +++ b/_config.yml @@ -1 +1,4 @@ -theme: jekyll-theme-minimal
\ No newline at end of file +theme: jekyll-theme-minimal +include: [CONTRIBUTING.md] +plugins: + - jemoji |