Guides

Aber vorher gibt es einige Schritte die eigentlich immer gleich bleiben. Es bietet sich aber auch für Änderungen an, ein Issue zu schreiben.

Wie mache ich mit?

Für viele scheint es das erste mal mit git, (eventuell Markdown), Typescript, next.js und GitHub zu arbeiten.

Also was braucht ihr für htwr?

Kommt drauf an was ihr machen wollt:

  • Wollt ihr nur Rechtschreibfehler oder Grammatik korigieren?

    Ihr braucht git und einen Text Editor aka vs-code (ich benutzte Neovim btw.)

  • Wollt ihr alte Zusammenfassung überarbeiten (neue Themen hinzufügen)? (Keine neuen Fächer hinzufügen)

    Ihr braucht git und einen Text Editor aka vs-code mit mdx/markdown support. Siehe unten.

  • Wollt ihr neue Websiten/alte überarbeiten, die keine Panikzettel sind oder Zusammenfassungen sind?

    Ihr braucht git, pnpm, node.js und eine IDE (am besten mit prettier, eslint und tailwind plugins installiert)

  • Wollt ihr neue Fächer hinzufügen?

    Wie oben

Es gibt aber ein paar Grundschritte die immer getan werden sollten/müssen.

Step 1 Fork

Geht auf das Repository github.com/jonsch318/htwr-aachen.de und fork es. (Wenn ihr gerade schon da seit könnt ihr auch gerne eine Stern dalassen 🌟)

Ein fork kopiert den Master branch in ein eigenes repository, wo ihr Rechte habt und somit dran arbeiten könnt. (Grob gesagt)

Dies geht über den Button Fork oben links ForkButton

So ihr solltet jetzt euren eigenes htwr-aachen repository haben. Nur für euch :).

Step 2

Sagen wir mal ihr habt den GitHub username malory 😈 dann sagt ihr

git clone https://github.com/malory/htwr-aachen.de

die URL könnt ihr auch unter GitHub mit dem clone Button sehen

GitHub Clone Button

in einem Pfad euerer Wahl. Dies erstellt ein subdirectory htwr-aachen.de mit allen Dateien die wir so haben. Im Moment auch allen Unterlagen (Außer Klausuren) deswegen ist es leider etwas größer.

GUIDES

So nun seit bereit fürs Mitarbeiten. Guckt also bei den docs vorbei oder folgt einem Guide: