Skip to content

Commit d3199b0

Browse files
authored
Add Performance category to the changelog and release notes (#16065)
* Add Performance category * Reorder the template to be fixes -> perf -> features -> ... * Add more documentation to the features template
1 parent e63669b commit d3199b0

2 files changed

Lines changed: 11 additions & 0 deletions

File tree

qiskit_bot.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,4 +28,5 @@ categories:
2828
"Changelog: Deprecated": "Deprecated"
2929
"Changelog: Removed": "Removed"
3030
"Changelog: Build": "Build System"
31+
"Changelog: Performance": "Performance"
3132
"Changelog: None": null

releasenotes/config.yaml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@ sections:
4646
- [critical, Critical Issues]
4747
- [security, Security Issues]
4848
- [fixes, Bug Fixes]
49+
- [performance, Performance Improvements]
4950
- [other, Other Notes]
5051
template: |
5152
---
@@ -76,6 +77,15 @@ template: |
7677
7778
See `#15019 <https://github.com/Qiskit/qiskit/issues/15019>`__.
7879
80+
# Performance release notes are for runtime and output quality improvements which do not
81+
# include API or semantic changes.
82+
performance:
83+
- Measurable performance improvements.
84+
85+
# A feature is a new user-visible functionality. It can come in the form of a new function,
86+
# class, parameter, environment variable or any other user accessible and publicly documented
87+
# endpoint. In addition, new capabilities (for example "Qiskit can now compile to Clifford+T"),
88+
# newly supported workflows and new types of language interoperability are considered features.
7989
# Choose only the "features" sections you need and delete the rest. Try to be concise. You may
8090
# use a code example for complicated features.
8191
features_c:

0 commit comments

Comments
 (0)