# How to contribute to hitobito

First off, thank you for considering contributing to hitobito. hitobito is made for and by its own community. Happy to welcome you.

Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue, assessing changes, and helping you finalize your pull requests.

hitobito is an open source project and we love to receive contributions from our community — you! There are many ways to contribute, be it expanding the documentation, submitting bug reports, feature requests, comment issues or writing code.

Currently, the rest of this document is only available in German. Translations are welcome :man_dancing:

# Ground Rules

* Nicht nur der Source Sode von hitobito ist offen, sondern auch die Menschen, welche mit und an hitobito arbeiten.
* Damit wir alle noch lange Freude an hitobito haben, wünschen wir uns eine gute Qualität.
* Auch kleine Anpassungen sind willkommen.

# Your First Contribution

* Falls du noch keine Erfahrung mit Contributions gemacht hast, hilft dir sicher dieser [Guide](https://github.com/firstcontributions/first-contributions).
* Als Einstieg hilft dir sicher unsere [Entwicklungsumgebung](https://github.com/hitobito/development). Damit kannst du sehr einfach bei dir eine lokale hitobito Instanz aufsetzten. 
* Die Architektur von hitobito beseht aus einem gemeinsamen [Core](https://github.com/hitobito/hitobito) und Organisations-spezifischen Erweiterungen in einem sogenannten Wagon. Weitere Details sind im [Konzept](https://github.com/hitobito/hitobito/blob/master/doc/development/04_wagons.md) beschrieben.
* Für Fragen steht dir das Entwicklungsteam im Rahmen der Möglichkeiten gerne zur Verfügung.


## Issue / Pull Request

Bitte überprüfe vor dem Eröffnen eines Issues oder Pull Requests ob nicht bereits ein Ticket besteht, welches deine Idee umschreibt. Falls du in einer Organisation tätig bist, welche hitobito einsetzt, kann es sein, dass innerhalb dieser Orgaisation auch Ideen gesammelt werden.
In diesem Fall sprich dich bitte mit den verantwortlichen Personen vorgängig ab.

Damit wir deinen PR möglichst einfach integrieren können, sind folgende Punkte wichtig:
* Issue mit kurzer fachlicher Beschreibung
* Die Tests sollten erfolgreich durchlaufen, und je nach Feature sollten neue Tests geschrieben werden
* Vermerk der Änderung im Changelog
* Falls notwendig Übersetzungen in Tranisfex

Bei Fehlern helfen uns folgende Informationen:
* Verwendete Umgebung
* Komplette URL wo der Fehler auftritt
* Schritte um das Problem zu reproduzieren
* Verwendeter User
* Zeit und Datum des Auftretens des Fehlers

# How to suggest a feature or enhancement
tbd

# Code review process
tbd

# Community
Hinter hitobito steckt eine Community aus Personen welche an hitobito entwicklen und hitobito benutzen.
Regelmässige Treffen bringen die Community zusammen und hitobito weiter. Hier werden auch gemeinsame, zukünftige Entwicklungen und Features besprochren.
