CONTRIBUTING.md

Wie beteilige ich mich am Projekt?

Erstmal sind alle Beiträge, egal ob es durch Code, Ideen oder auch einfach nur Feedback wichtig und tragen zu der Abgabe bei. Jeder hilft und gibt so viel wie er kann.

Wie füge ich Code hinzu?

Wir arbeiten nach dem GitHub-Flow Prinzip. Das heißt, dass wir die Funktionen von unserer Plattform, bei uns GitLab nutzen, um strukturiert und übersichtlich gemeinsam am Projekt zu arbeiten. Dabei gibt es folgendes zu beachten:

• Die Branches dev und main sind protected. Das heißt, auf die wird nicht einfach so gepushed oder sonstiges getan.
• main enthält nur fertige Inkremente des Projekts. Es muss zwingend lauffähig / präsentierbar sein, was da landet
• dev enthält immer den aktuellesten Stand der Entwicklung. Auch auf den wird nicht einfach so gepushed.
• Wenn man was einbringen will, dann erstellt man einen Branch von dev ab, welcher einen sinnvollen Namen hat (bspw. feature/player-movement)
• Auf diesem Branch arbeitet nur die Person, die ihn erstellt hat.
• Ist man mit seinen Änderungen fertig, macht man eine Merge-Request auf dev auf.
• Nachdem die von anderen reviewed wurde und für gut befunden wurde, wird der Code in dev gespeichert und der Branch auf dem entwickelt wurde gelöscht.

Umgang mit Issues

Die Issues dienen als Übersicht über zu erledigende Aufgaben. Dabei sind die nicht in Stein gemeißelt, Diskussionen und ggf. Aufsplitten in weitere Issues ist explizit erwünscht.

Wenn man einen Bug findet, dann macht man am Besten eine entsprechende Issue auf, welche auch enthält, wie man den Bug reproduziert. Dann kann jemand, wenn er Zeit hat, den Bug fixen und es bleibt dokumentiert, wie man dahin gekommen ist.