Add tooling directory for community-built tools, per Slack discussion - #33
Add tooling directory for community-built tools, per Slack discussion#33m-khan-97 wants to merge 2 commits into
Conversation
Creates the tooling/ home John suggested creating via PR: an index of in-repo tools and community reference tooling, each mapped to the QS entries it operationalises, with contribution steps and an open question on code licensing (CC BY-SA suits documentation, not source). Seeds the index with the incoming QIR/LLVM circuit mapper and pq-audit as reference tooling for QS04 inventory work.
|
community tools should be on awesomelist and owasp developed tools in a tools directory after we define the readiness guides and addistional once. |
Removes the pq-audit external-repository reference and states the scope explicitly: this directory is for tools authored as OWASP Quantum Security Project output and living in this repo, not links to independently maintained external projects, which belong on the awesomelist instead. Addresses the risk Roy flagged directly - that listing an unmaintained external repo here reads as an endorsement or verification the project isn't positioned to give. Also records the sequencing point: general tooling work follows the readiness guides (the assessment in tooling/assessment/), not the other way round.
|
Agreed on both, and pushed a fix rather than just a reply. Removed the pq-audit reference entirely and restated scope explicitly: this directory is for tools authored as project output and living in this repo, not links to externally maintained projects - those belong on the awesomelist, which exists exactly to avoid the endorsement problem you flagged. Added the disclaimer directly in the README so it does not depend on anyone remembering this thread: presence here states a tool declared maturity, not an OWASP quality mark. On sequencing - recorded it as written: general tooling work follows the readiness guides, not the other way round. The assessment (#34) is what this directory exists to hold right now; anything broader waits. If the read is that this should not exist as a separate directory yet at all - e.g. the assessment should just live under |
2 participants
Creates the
tooling/folder:What this adds
A single
tooling/README.mdestablishing the directory:curates external resources;
tooling/holds work the community builds andmaintains in-repo. A tool that graduates to its own repository keeps an index
entry.
with the QIR/LLVM circuit mapper Gabriel Ambroise described in the thread
(listed as incoming, so the slot is ready when he is) and pq-audit as
community reference tooling for QS04 inventory work.
subdirectory with a README stating what it does, which QS entries it maps to,
how to run it, and its maturity; add an index row with a named maintainer.
Open question for the leads
The repository license is CC BY-SA 4.0, which suits documentation but is not
designed for source code. Before substantial code lands in
tooling/, it may beworth designating a standard code license for this directory's contents
(Apache-2.0 and MIT are the common choices), with CC BY-SA continuing to cover
documentation. Flagged for decision rather than assumed.
Relationship to other work
A separate PR proposes the first resident tool - the markdown-first Quantum
Readiness Assessment from the charter's Track 1. The two are kept apart so this
directory-creation PR stays trivially mergeable; the index row for the
assessment updates once both land.