Formalize Quantum Top 10 entry template - #40
Open
galoisField7 wants to merge 1 commit into
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Formalize the Quantum Security Top 10 Entry Template
Summary
This PR updates the Quantum Security Top 10 entry template to formalize conventions that have already emerged during the development of the v0.1 entries and the subsequent community discussions.
The goal is not to increase the amount of content required for each entry, but to improve consistency, clarify scope boundaries, and make the guidance more useful for practitioners.
This PR follows the discussion in #15 and incorporates subsequent community feedback.
Motivation
While reviewing the current Top 10 entries, several concepts repeatedly appear despite not being part of the current template.
Examples include:
Rather than leaving these as ad hoc additions, this PR incorporates them into the common authoring template.
The changes are intended to codify conventions that are already emerging across the project rather than introducing entirely new concepts.
Proposed Changes
Scope
Introduce an explicit Scope section to clearly define what an entry covers and, where useful, what it explicitly does not cover.
This helps reduce overlap between entries and makes the taxonomy more consistent.
Evidence
Introduce an Evidence section together with a common evidence convention.
Each entry classifies the maturity of the attack class using one of:
The detailed definitions are maintained in a separate
EVIDENCE.mddocument to keep the Top 10 concise while ensuring consistent classification across entries.Detection
Introduce a Detection section describing practical ways organisations can determine whether they are exposed to the risk.
Examples include:
Mitigation Guidance
Clarify that, where practical, mitigations should be:
The intention is to encourage engineering-oriented guidance while leaving detailed verification procedures to future supporting guidance rather than the Top 10 itself.
Standards & Regulatory Mapping
Formalize this section within the template.
Every current migration entry already contains standards and regulatory mapping, making it a de facto part of the project. Including it in the template improves consistency and strengthens the usefulness of the Top 10 for regulated industries.
Related Risks
Introduce a Related Risks section allowing entries to reference adjacent Quantum Security Top 10 risks and briefly explain the relationship.
This improves navigation and helps clarify scope boundaries.
Benefits
These additions make the Top 10:
Non-goals
This PR intentionally does not rewrite the existing Top 10 entries.
The revised template can be adopted incrementally as entries continue to evolve.
Related Discussions
This PR implements the template improvements discussed in #15.
The proposed evidence field is designed to work together with a separate evidence convention, should the project decide to adopt one.