Please open a new branch with the naming scheme feature/<#Issue>-<#Description> or fix/<#Issue>-<#Description>
regarding the type of the change. Do a descriptive pull request against the main branch. Prepare the pull request;
we prefer small requests, that are squashed into the main branch.
Pull request on an open issue have higher priorities, because every pull request should be inclusive and everyone in the community should be enabled to talk about the changes. So it is highly recommend to open an issue first, before starting development.
Check the release with
./tooling.shtooling.sh as it runs a pipeline-like check on your local environment.
Use swiftlint (best in your IDE while saving) to lint the code before committing it.
tooling.sh has a lint option that lists all errors end warnings that should have been fixed
before committing the pull request.
Pipelines must succeed
The CI will test the project first for a list of requirements:
- A zero warning state is desirable
- All tests must pass
- A sufficient code coverage is required
Find Friends
A pull request has to be approved by at least one other person.
All threads must be resolved
Code comments are highly recommended. Be precise in your critique rather than polite. Both is most welcome.
Do not merge code that contains sources that are unused and leftovers.
When contributing to this repository, please first discuss the change you wish to make via an issue.
Please note we have a code of conduct, please follow it in all your interactions with the project.
You have to agree to the Developer Certificate of Origin!
We are using Trunk-based Development. Do always a feature-branch for your commit and open a merge request back into the main branch when you are absolutely sure that it works. Ask another member of the team if you are not sure about it.
- Ensure any install or build dependencies that aren’t covered by the tooling.sh script are removed before committing the pull request.
- Update the CHANGELOG.md with details of changes to functionality and to all interfaces, this includes new environment variables, exposed ports, useful file locations and container parameters.
- Let other people review your merge request and add suggestions made by the community into your code.
- Our code of conduct