Code We strive to keep the code compatible with the Python versions used in Debian Stable and the last two Ubuntu LTS releases. As of writing, these are Python 3.8, 3.9, and 3.10. To improve readability and consistency we use the PEP 8 guidelines. Developers are encouraged to write their code as strictly compliant as possible. Tools To make development and validation easier, we adopted pre-commit hooks to automate most of this. This will help identify broken/bad code, improve consistency and save time during code reviews. Some tools and hooks have been adopted for both local development as well as in our CI/CD pipeline as GitHub actions. Some of the tools are:

In principle, all project management is handled in a central board. Issues and PRs may be created in the repositories of the KAT modules, as long as they are linked to the central board. All (linked) issues and PR's should be assigned to a status column, and have an assignee so we know who is chiefly responsible / who should take action. Developers are encouraged to use the Review column(s) to get their PR's merged, and to regularly check if they can help review something. Feature Milestones Although we have no fixed release schedules, we focus on a pre-defined list of tasks each iteration/cycle. At the beginning of each release cyle, we take inventory of which (major) functionality we want to implement. This will most likely be based on cards in the "incoming features and refinements" column on the project board. We agree to prioritize our collective effort on implementing that functionality, although there is always time for bug fixing, testing, and quality control. All tasks that belong to that cycle should have an appropriate milestone label in the project board, and should be moved to the To-Do column. A cycle only ends if either: functionality is no longer required (i.e. changing requirements);

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