Skip to content

Meet PQCP Project Documentation Standards #6

@mkannwischer

Description

@mkannwischer

The PQCP TSC agreed on common project documentation standards for all PQCP sub-projects - see pq-code-package/tsc#151.

Please ensure that your project has at least the following information in your README:

  • Getting started
  • Status (recommended for production/in development/etc)
  • Constant-time goals / properties
  • Verification scope (which parts of the code are covered and which guarantees are obtained)
  • Performance (how to reproduce - speed+memory+binary size)
  • ACVP testing coverage

Please try to complete this issue by the next PQCP TSC meeting (2025-12-04).

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions