Skip to content

Contribution guidelines

namazso edited this page May 6, 2025 · 2 revisions

If you want to use the official PawnIO driver with a module, it needs to be merged to this repository. The modules here are periodically built, signed, and released. Contributing has some requirements:

  • The module must be under LGPL 2.1 license.
  • The module must not have security vulnerabilities.
  • The module must compile with no warnings on CI.
  • The module must not expose functionality that aids compromising software security measures.
  • The module must have Doxygen-style documentation on every exposed ioctl.
  • The module must be usable by everyone (no Pawn-side lockdown).
  • The module should be simple.
  • The module should do best effort to ensure it only runs with supported hardware.
  • The module should avoid dynamic sized arrays wherever possible.
  • The module should be replacing WinRing0-like access, not proper first party drivers if those exist.
  • The pull request should provide reference code and/or datasheets.

Clone this wiki locally