Guidelines for deprecation/removal PRs in Qiskit 0.46/1.0 #36
Replies: 2 comments 1 reply
-
Who will open the second PR in this case? A maintainer? |
Beta Was this translation helpful? Give feedback.
1 reply
-
|
We wrote a small blogpost to give some context on it https://www.ibm.com/quantum/blog/transition-to-1 |
Beta Was this translation helpful? Give feedback.
0 replies
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
-
The Qiskit versioning and deprecation policy around major versions indicates that immediately following new major versions (i.e.
1.0), a final minor version (i.e.0.46.0) will be released. The purpose of this last minor version (0.46.0) is to include deprecation warnings that document the API changes that take place in1.0. For this reason, the current Qiskit repositorymainbranch is set to the1.0version , and we additionally support astable/0.46branch.Supporting more than one stable branch at the same time makes certain processes trickier than before. To remove code in Qiskit
1.0that hasn't been previously deprecated in0.45.0, we generally recommend following this 2-step process:stable/0.46branch issuing deprecation warningsmainbranch removing the corresponding codeThis is the most resource-efficient way to do it. However, some contributors might not be as familiar with different branching strategies, so alternatively, we could also support the following 2-step process:
mainbranch issuing deprecation warnings . This PR must then be manually backported tostable/0.46by leaving a comment with@Mergifyio backport stable/0.46after the PR is merged (can be done by a maintainer).mainbranch removing the corresponding codeI wanted to document somewhere how things are generally done, and I'm open to proposals in case there is a way to make things easier for external contributors.
Beta Was this translation helpful? Give feedback.
All reactions