Contributions
All contributions, bug reports, bug fixes, documentation improvements, enhancements and ideas are welcome. You can directly join and be involved in the development of OpenKAT:
Install and use OpenKAT and provide feedback
Development of boefje, normalizer and bit plugins
Propose new features
Report bugs
Solve tickets with a
good first issue
labelPort OpenKAT to other systems
Note that it is required to sign a Contributor License Agreement when submitting.
The CLAassitant
bot will request this automatically on your first Pull Request.
Contribute to Codebase
See Development for our code style, coding conventions, and overall workflow.
Fork the right repository in GitHub
- Create a new branch from either
main
or a release tag. Note thatmain
changes rapidly, and as such may not be a suitable basis for your work. This branch should be in the following format:
[feature|enhancement|bug|hotfix]/random-cat-popup-on-screen
- Create a new branch from either
- Commit and push the code
Make sure the code is linted, formatted and has correct typing
The code must pass
pre-commit
locally
- Submit Pull Request
Make sure your code is tested and the PR has a good title and description
Use the PR template
Let your code be reviewed
You might have to update your PR after remarks and submit rework for approval
Contribute Documentation
Contributing to the documentation benefits everyone who uses OpenKAT. We encourage you to help us improve the documentation, and you don’t have to be an expert using OpenKAT to do so. There are many sections that are better off written by non-experts. If something in the docs doesn’t make sense to you, updating the relevant section might be a great way to ensure it will help the next person. You’re welcome to propose edits to almost every text, including comments and docstrings in the code, this documentation, and other files.
You could help us out with the following sections:
Code documentation
Tutorials
Translations
This document
All documentation should be placed in a repository’s docs
folder.
Code of Conduct
See the Code of Conduct of the Ministry of Health, Welfare, and Sport.
Security
See the Responsible Disclosure Statement of the Ministry of Health, Welfare, and Sport.