We welcome contributions to improve Watcher, whether through new features, bug fixes, documentation, or optimizations. This guide explains how to set up your development environment and submit changes via Pull Requests (PRs).
Documentation: https://thalesgroup-cert.github.io/Watcher/
Include: OS, Python version, Watcher version, steps to reproduce, expected vs actual behavior, and logs.
Describe the problem being solved, proposed solution, and use cases. Open an issue for discussion before implementing.
Use GitHub Security Advisories. Do not open public issues.
# Create branch
git checkout -b feature/<short_feature_name>
# Make changes and commit
git commit -m "Short title" -m "Optional longer description"
# Push and open PR
git push origin feature/<short_feature_name>Follow Conventional Commits:
feat:New featurefix:Bug fixdocs:Documentationrefactor:Code refactoringtest:Testschore:Maintenance
- Fill Pull Request template completely
- Link related issues with
Fixes #123 - Pass all tests
- Follow code style
- Update documentation if needed
- Minimum 80% test coverage for new code
feature/- New featuresfix/- Bug fixesdocs/- Documentationrefactor/- Code improvements
- All PRs are reviewed by project maintainers.
- Reviews may request changes for consistency, security, or clarity.
- Once approved, your PR will be merged into the
testbranch, then later intomaster.
- Keep commits small and focused.
- Write clear commit messages.
- Ensure code is formatted and linted.
- Add/update tests where relevant.
- Update documentation when introducing changes.
Following these steps helps us keep Watcher reliable, maintainable, and secure.