Thank you very much for your interest in contributing to our project! As a public service company, we want to shape a product that better matches our user needs and desires. Ideas or direct contributions are therefore warmly welcome and will be considered with great care, provided they fulfill a few requirements listed in this document. Please read it first before you decide to contribute.
Our development team is small, our ability to quickly evaluate a need or a code submission is therefore critical. Please follow the present contributing guidelines so that we can efficiently consider your proposal. You should also read or our code of conduct, providing a few guidelines to keep interactions as respectful as possible.
Any kind of contribution is welcome, as long as it improves the overall quality of our product, for example:
- Requests for new features or ideas.
- Bug reports or fixes.
- Documentation improvements.
- Translation improvements.
Contributions can either take the form of simple issues where you describe the problem you face or what you would like to see in our products. If you feel up to the challenge, you can even submit code in the form of pull requests which our team will review.
Requests which are too vague or not related to our product will not be taken into account. We also have no editorial influence, any issue related to the content available on our platform will simply be closed.
You can use issues to report bugs, submit ideas or request features. People with a programming background can also submit changes directly via pull requests. Creating issues or pull requests requires you to own or open a GitHub account.
If you are not sure about the likelihood of a change you propose to be accepted, please open an issue first. We can discuss it there, especially whether it is compatible with our product or not. This way you can avoid creating an entire pull request we will never be able to merge.
Templates are available when you want to contribute:
- Issues: Please follow our issue template. You can omit information which does not make sense but, in general, the more details you can provide, the better. This ensures we can quickly reproduce the problem you are facing, increasing the likelihood we can fix it.
- Pull requests: Please follow our code conventions and workflows, test your code well, and write unit tests when this makes sense. We will review your work and, if successful, merge it back into the main development branch.
Quality checks can be run using:
make check-quality
This ensures that Swift files, and scripts conform to common best practices.
Objective-C files currently have no formal code conventions, but we try to keep our codebase consistent. In general, having a look at the code itself should be enough for you to discover how you should write your changes.
Pull requests, once complete, can be submitted for review by our team. Depending on the complexity of the involved changes, a few iterations might be needed. Once a pull request has been approved, it will be squashed and merged back into the development trunk and delivered with the next release.