Add tooling directory for community-built tools, per Slack discussion - #33
Open
m-khan-97 wants to merge 1 commit into
Open
Add tooling directory for community-built tools, per Slack discussion#33m-khan-97 wants to merge 1 commit into
m-khan-97 wants to merge 1 commit 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.
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
1 participant
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.
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.