Contributing to Integreat is always appreciated! Just start by opening a pull request, reporting a bug or contact us if you don't know where to start.
If you don't know where to start or if you want to know more about Integreat, contact Max, Steffen or our info mail and visit our website.
Other team members you can contact are Sarah, Steffi and Sven.
Before starting to write code and opening a pull request, please take a look at our conventions.
Pull requests should always belong to an issue in our issue tracker.
To merge a pull request, it has to match our Definition of Done. It includes among others:
- All checks (linting, unit and e2e tests, ...) have to pass.
- No changes are requested.
- Two approvals are needed.
- New and changed functionality should be tested sufficiently, both manual and by writing unit tests.
Creating a pull request from a fork prevents checks from the CI. It is a good way to make contact though.
Pull requests with changes that are visible to our end users should always include one (or more) release note describing the changes.
For other changes, these release notes are optional, but make sure to set the flag show_in_stores to false.
To add a release note:
- Have a look at the template.
- Add a new release note to the unreleased directory.
This gives users, members of other teams and us developers a simple overview over which changes and features belong to which release. The release notes can be found here and are automatically moved to a new release directory during a release. They are also shown in the stores and the release section of github.
You can view our issues or create new ones on our jira.