mirror of
https://github.com/prometheus/prometheus.git
synced 2026-02-03 20:39:32 -05:00
PR template: add a concrete release notes example (#17721)
Signed-off-by: Arve Knudsen <arve.knudsen@gmail.com>
This commit is contained in:
parent
f390163d33
commit
2262ae2542
1 changed files with 1 additions and 0 deletions
1
.github/PULL_REQUEST_TEMPLATE.md
vendored
1
.github/PULL_REQUEST_TEMPLATE.md
vendored
|
|
@ -28,6 +28,7 @@ If no, just write "NONE" in the release-notes block below.
|
||||||
Otherwise, please describe what should be mentioned in the CHANGELOG. Use the following prefixes:
|
Otherwise, please describe what should be mentioned in the CHANGELOG. Use the following prefixes:
|
||||||
[FEATURE] [ENHANCEMENT] [PERF] [BUGFIX] [SECURITY] [CHANGE]
|
[FEATURE] [ENHANCEMENT] [PERF] [BUGFIX] [SECURITY] [CHANGE]
|
||||||
Refer to the existing CHANGELOG for inspiration: https://github.com/prometheus/prometheus/blob/main/CHANGELOG.md
|
Refer to the existing CHANGELOG for inspiration: https://github.com/prometheus/prometheus/blob/main/CHANGELOG.md
|
||||||
|
A concrete example may look as follows (be sure to leave out the surrounding quotes): "[FEATURE] API: Add /api/v1/features for clients to understand which features are supported".
|
||||||
If you need help formulating your entries, consult the reviewer(s).
|
If you need help formulating your entries, consult the reviewer(s).
|
||||||
-->
|
-->
|
||||||
```release-notes
|
```release-notes
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue