If you want to contribute to this project, please stick to the following guidelines. Thank you for your work!
In all contributions, please stick to the code of conduct and be aware that your contribution will be published under the projects license.
Wether you want to tackle an already existing issue or bring you own one, we recommend to explain your suggested solution in the issue discussion, before beginning implementation. Issues which we think are good for newcomers are flagged as good first issue and provide a good entry into contributing to munify.
Github allows for easy branch creation from an issue. We recommend to do so. We require you to develop on a branch and later create a pull request which will then get reviewed and eventually merged into the main branch. Since code reviews take up a lot of time, please be patient and try to commit well documented and clearly structured code. The best documentation is always the one explaining the why.
We try to stick as close to the conventional commit specification as possible:
feat:a new featurefix:a bugfixstyle:stylistic changes to the Appwip:work in progressformat & lint:formatting and linting changestyping:changes to fulfill typing requirementsperf:a code change that improves performancedocs:a documentation updatetest:a test updatechore:project housekeepingrefactor:refactor of the code without change in functionalitybuild:changes that affect the build system or external dependenciesci:changes to CI configuration files and scriptsrevert:reverts a previous commitmerge:use when merging branches
If you are using the vscode extension rioukkevin.vscode-git-commit, the right settings for the convention above should be applied through the settings.json automatically.
Below are examples of well-formatted commits:
✨ feat (Frontend): implement login button and modal
branch: login
🐞 fix (General): address error in login body
branch: login
📚 docs (Backend): add examples
branch: setup