Skip to content
This repository was archived by the owner on Dec 7, 2021. It is now read-only.

Add reno for release notes and update CONTRIBUTING guide #1002

Merged
merged 5 commits into from
May 19, 2020

Conversation

mtreinish
Copy link
Contributor

Summary

Moving forward aqua will be using reno for release documentation. This
commit adds a pro-forma release note and the documentation configuration
to verify release notes moving forward. It also updates the CONTRIBUTING
guide to reflect this new change.

Details and comments

Fixes #990

Moving forward aqua will be using reno for release documentation. This
commit adds a pro-forma release note and the documentation configuration
to verify release notes moving forward. It also updates the CONTRIBUTING
guide to reflect this new change.

Fixes qiskit-community#990
@Cryoris
Copy link
Contributor

Cryoris commented May 19, 2020

Awesome, thanks! 🎉

@mtreinish
Copy link
Contributor Author

Once this merges I will add the qiskit-bot configuration to the repo to enable the automation workflow and rename the stable branch stable/0.7 (so the qiskit-bot release automation workflow can do its thing)

Copy link
Member

@woodsp-ibm woodsp-ibm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

At some point, hopefully like other common contribution text, this could all go to the common location in docs. Maybe it could already and just state in the elements that this aspect is managed by reno and give a ref.

I think we need a few Labels added for this capability right.

@mtreinish
Copy link
Contributor Author

My goal is to get everything in docs before too long, after this the only repo left for me to add this to is the ibmq provider then I'll push up the docs change and we can remove it from the local CONTRIBUTING guides for each element. Shouldn't be too long, but until then it'll be good to make sure its documented locally

@mtreinish
Copy link
Contributor Author

I actually already created the labels for this just now. You can start tagging anything with the Changelog: labels whenever (even after a PR has merged) and when they're included in a release they'll be included in the changelog added to the release page.

@mtreinish mtreinish changed the title Add reno fore release notes and update CONTRIBUTING guide Add reno for release notes and update CONTRIBUTING guide May 19, 2020
woodsp-ibm
woodsp-ibm previously approved these changes May 19, 2020
Copy link
Member

@woodsp-ibm woodsp-ibm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks Matthew. And I see the Labels now

@manoelmarques manoelmarques merged commit 1b08c3c into qiskit-community:master May 19, 2020
@mtreinish mtreinish deleted the use-reno branch May 19, 2020 14:19
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Use reno for releasenotes
4 participants