Skip to main content
Version: Next

Contributing

Code and documentation contributions​

  • Open issues and pull requests in the noxtls-oem-rust repository.
  • Keep documentation aligned with actual exported Rust APIs and crate feature flags.
  • Include tests for TLS/crypto behavior changes where practical.

Documentation standards​

  • Update relevant topic pages in the same change as implementation updates.
  • Regenerate OEM-parity algorithm pages after large crypto API changes: python docs/scripts/gen_api_algorithm_pages.py (from repo root).
  • For new feature flags or policy toggles, update:
  • Keep cross-links current between TLS, crypto, X.509, and applications pages.

Documentation versioning​

For docs versioning workflow, see:

Review checklist​

  • Workspace build and tests pass for changed crates.
  • New feature toggles and policy implications are documented.
  • Security-sensitive behavior changes are called out in release notes.
  • API references and usage snippets match current Rust symbols and signatures.