Skip to content

Contributing

CyberSnakeH edited this page Dec 1, 2025 · 1 revision

Contributing

We welcome well-documented, security-conscious contributions.

Guidelines

  • 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).

Workflow

  1. Fork and create a feature branch.
  2. Keep changes scoped and focused.
  3. Include rationale in commit messages.
  4. Run local builds (./deploy.sh build) and, if applicable, DKMS install on a test kernel.
  5. Submit a pull request with a short summary and any testing notes.

Reporting Issues

  • Include kernel version (uname -r), distro, and whether DKMS was used.
  • Attach relevant dmesg excerpts and deploy.sh output if install-related.
  • Note if AppArmor/SELinux is enforcing and any audit logs.

Clone this wiki locally