Add reno release notes for 0.9 release #2919
Merged
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
This commit starts the process of adding release notes using reno to qiskit-terra. This notes for several of the user facing changes in the 0.9 release so far. We can continue to modify release notes after the fact because they're tied to the git history for which release they're associated with. New release notes can be added with: "reno new $name" and you can generate rst output using "reno report" Moving forward the expectation is that we'll require a PR to include release documentation in the form of a reno release note before we merge it, if it contains a user facing change. Release notes differ from changelog in that they provide much more detail to end users on what has changed, how they can adapt to it, and why it was changed (if necessary). Accordingly the release notes are free form restructured text that enables writing as much as needed. While the changelog is just a record of a change that has potential end user impact and normally doesn't provide the detail needed by users. Honestly the changelog creation shouldn't be a manual process it should be automatically generated using a combination of git and commit msg metadata. Fixes Qiskit#2230
This comment has been minimized.
This comment has been minimized.
1ucian0
reviewed
Aug 18, 2019
1ucian0
reviewed
Aug 18, 2019
Co-Authored-By: Luciano <luciano.bello@ibm.com>
|
Ok, I've applied the suggestions. Fwiw, we don't have to correct all the small issues in this review. We can do a lot of that in follow up PRs too. The whole point of reno is that it enables us to edit things as we build the release. It lets us switch to a more iterative method for building release documentation. |
ajavadia
reviewed
Aug 19, 2019
ajavadia
previously approved these changes
Aug 19, 2019
Co-Authored-By: Ali Javadi-Abhari <ajavadia@users.noreply.github.com>
ajavadia
approved these changes
Aug 19, 2019
faisaldebouni
pushed a commit
to faisaldebouni/qiskit-terra
that referenced
this pull request
Aug 5, 2020
* Add reno release notes for 0.9 release This commit starts the process of adding release notes using reno to qiskit-terra. This notes for several of the user facing changes in the 0.9 release so far. We can continue to modify release notes after the fact because they're tied to the git history for which release they're associated with. New release notes can be added with: "reno new $name" and you can generate rst output using "reno report" Moving forward the expectation is that we'll require a PR to include release documentation in the form of a reno release note before we merge it, if it contains a user facing change. Release notes differ from changelog in that they provide much more detail to end users on what has changed, how they can adapt to it, and why it was changed (if necessary). Accordingly the release notes are free form restructured text that enables writing as much as needed. While the changelog is just a record of a change that has potential end user impact and normally doesn't provide the detail needed by users. Honestly the changelog creation shouldn't be a manual process it should be automatically generated using a combination of git and commit msg metadata. Fixes Qiskit#2230 * Add more release notes * Add more release notes for new features * Add more release notes * Add more upgrade notes * Add reno lint check to CI * Add more notes * Add release notes for changes that were missing a changelog entry * Expand incomplete notes * Fix whitespace * Add documentation on release notes to CONTRIBUTING.md * Add qsphere update release notes * Update diagGate() name to diag_gate() * Add release notes for pulse samplers * Add release notes for layout in circuit drawers * Add upgrade note about new warnings * Replace stray hardtab with spaces * Add release note on line magic api change * Apply suggestions from code review Co-Authored-By: Luciano <luciano.bello@ibm.com> * Update CONTRIBUTING.md Co-Authored-By: Ali Javadi-Abhari <ajavadia@users.noreply.github.com> * Fix typo
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.
Summary
This commit starts the process of adding release notes using reno to
qiskit-terra. This notes for several of the user facing changes in the
0.9 release so far. We can continue to modify release notes after the fact
because they're tied to the git history for which release they're
associated with. New release notes can be added with: "reno new $name"
and you can generate rst output using "reno report". The plan is to
generate an rst file at each release and copy it into the documentation
repository as part of the release process (eventually this will hopefully
be automated).
Moving forward the expectation is that we'll require a PR to include
release documentation in the form of a reno release note before we merge
it, if it contains a user facing change. The goal being to switch the burden of
writing detailed release documentation off of solely me and share it among
the contributors to terra. Once we start using reno the expectation is that
PR authors will also write the release notes for any user facing change
they contribute.
Release notes differ from changelog in that they provide much more detail
to end users on what has changed, why it was changed, and how they can
adapt to it. Accordingly, the release notes are free form restructured text
that enables writing as much detail as needed to inform users of how to
adapt or leverage any changes in a new release. While the changelog is
just a record of a change that has potential end user impact and normally
doesn't provide the detail needed by users. Honestly the changelog
creation shouldn't be a manual process it should be automatically
generated using a combination of git and commit msg metadata.
We can continue to tweak and add on to these notes until we tag the release
and any additional notes files will be automatically included in the 0.9 notes.
After the release we can modify the release notes by modifying an existing
file.
Details and comments
Fixes #2230