# 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** label - Port OpenKAT to other systems ## Contribute to Codebase See [DEVELOPMENT.md](https://github.com/minvws/nl-kat-coordination/blob/main/DEVELOPMENT.md) for our code style, coding conventions, and overall workflow. - Fork the right repository in GitHub - Create a new branch from `main` (and make sure it is always up-to-date with the OpenKAT main branch!) - This branch should be in the following format: - `[feature|enhancement|bug|hotfix]/random-cat-popup-on-screen` - 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, the wiki, 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. ## Contributor Social Contract All contributors (including, but not limited to, developers and issue reporters) promise to do their best to adhere to the guidelines in [CONTRIBUTIONS.md], [DEVELOPMENT.md], and [MANAGEMENT.md]. Everyone is encouraged to politely and constructively point out guidelines violations to others. Actively enforcing these guidelines makes that the entire project benefits in quality control. ## Code of Conduct See the [Code of Conduct of the Ministry of Health, Welfare, and Sport](https://github.com/minvws/.github/blob/main/CODE_OF_CONDUCT.md). ## Security See the [Responsible Disclosure Statement of the Ministry of Health, Welfare, and Sport](https://github.com/minvws/.github/blob/main/SECURITY.md).