-
Notifications
You must be signed in to change notification settings - Fork 179
Q# API Design Process
This page defines the Q# API design review process, used to help review API proposals for consistency with the Q# API Design Principles.
The API design review process includes and addresses the following:
- New Q# library designs (i.e.: new namespace and/or package)
- Major new Q# library features
- Significant refactoring of existing Q# libraries
Code and API designs covered by this process may be in any public repository that includes Q# APIs. In particular:
- microsoft/qsharp-runtime (i.e.: subsets implementing QSharpCore)
- microsoft/QuantumLibraries
- microsoft/Quantum-NC
This document does not include and does not address:
- Q# applications not intended for use as libraries (NB: the Q# style guide still applies even to Q# applications without an API surface). For example, samples, katas, and other documentation code are not affected by this proposal, as design changes can be made without breaking user code.
- Fixes and improvements to Q# libraries made directly through GitHub pull requests that do not include API changes. Note that even small changes to API surface may be in scope, however.
-
Consistency with design principles: All Q# APIs and library designs produced through this process will be consistent with established API design principles.
-
Transparency: Decisions about Q# APIs and library designs will be traceable to help members of the quantum development community understand motivations and principles behind the Quantum Development Kit product.
-
User-driven: Decisions about Q# API and library designs will be motivated by user needs, and offering the best user experience possible. The decision-making process will explicitly take into account user feedback, as well as the impact of breaking user code, weighing that impact against potential improvements that can be enabled via breaking changes.
-
Creative disagreement: Providing input and feedback will not mean that suggestions and designs are automatically adopted. The libraries team will retain final say over Q# API designs and will work through this process to ensure that all disagreements are respectful and creative in nature.
-
Inclusive: In keeping with the Microsoft Open Source Code of Conduct, this process will not tolerate discriminatory and exclusive behavior. Participants that act in contravention to the Code of Conduct will not be allowed to continue providing feedback or joining discussions.
Issues and proposals that fall under the scope for this process should be tagged with the Status-NeedsApiReview label. Once tagged, proposals should be added to the API Review Scheduling project under the "Not yet ready for review" column or "Ready to be reviewed" column, depending on whether more work is needed before the proposal can be reviewed.
Before new releases, the libraries team will create a pull request with issues drawn from the cards under the "Ready to be reviewed" column of the API Review Scheduling project.
API designs for major refactoring of existing libraries, for major new library features, or for new libraries will be reviewed for adherence to design principles, and notes will be recorded on the result of this review and discussion as comments or edits to the PR. Based on the results of this discussion, action items will be recorded as well as any consensus reached on whether and how to move forward with each proposal. Cards for each proposal will be moved to "Reviewed: needs further revision," "Reviewed: needs further discussion," "Reviewed: rejected," or "Reviewed: approved" based on this consensus.
The API review pull request will be used to collect discussions and feedback from internal and external members of the quantum development community.