Contributing

We’re always interested in improvements in byro, and your help is welcome! We’ll review your contributions and give feedback on your changes, and help you if you’re not sure how to solve a problem.

Du wirst einen GitHub-Account brauchen, um zu byro beizutragen, und solltest wissen, wie man mit git pullt, pusht und committet.

Wenn du schon verbesserungen vor hast, erstelle bitte ein Ticket dafür. Ansonsten guck dir unsere offenen Tickets an und wähle eines, das du bearbeiten willst. Kommentiere gern am Ticket, wenn dir etwas nicht klar ist.

Zuerst solltest du byro forken, und dann dein Repo lokal clonen (GitHub wird dir sagen, wie das geht). Wenn du das Repo geclont und geöffnet hast, erstell einen neuen Branch, der die ID des Tickets enthält:

git checkout -b issue/123

Wenn dein Ticket Änderungen im Code benötigt, geh jetzt das Entwicklungs-Setup durch, dann mach hier weiter. Wenn du die Dokumentation anpassen willst, dann folge bitte dem Dokumentationssetup.

We have a couple of style checkers both for code and for documentation, as documented in the setup docs. We check them in our Continuous Integration for every commit and pull request, but you should run the tests and checks locally as well, and consider your pull request ready once those tests pass.

Please write helpful, well-formatted commit messages – you can find a guide here. Once you have committed your work, add yourself to the src/byro/office/templates/office/settings/about.html file, and push your branch:

git push -u origin issue/123

and open a pull request. This will cause our Continuous Integration to check your changes for any issues (breaking tests, code style issues, documentation style issues, …). Please give us five to seven days to get back to you with a review or a direct merge.