-
Notifications
You must be signed in to change notification settings - Fork 1
Contributing
CyberSnakeH edited this page Dec 1, 2025
·
1 revision
We welcome well-documented, security-conscious contributions.
- Keep kernel changes minimal and auditable; favor userland complexity.
- Preserve ABI compatibility in
snakedrv.h(bump version when required). - Follow existing code style (C: kernel conventions; C++: modern, RAII).
- Add comments where logic is non-obvious; avoid noise.
- Validate builds for both kernel and userland paths.
- Avoid regressions in security posture (udev/AppArmor/SELinux).
- Fork and create a feature branch.
- Keep changes scoped and focused.
- Include rationale in commit messages.
- Run local builds (
./deploy.sh build) and, if applicable, DKMS install on a test kernel. - Submit a pull request with a short summary and any testing notes.
- Include kernel version (
uname -r), distro, and whether DKMS was used. - Attach relevant
dmesgexcerpts and deploy.sh output if install-related. - Note if AppArmor/SELinux is enforcing and any audit logs.