Skip to content

Commit 2f36f98

Browse files
Add PR template for changelog automation (#1517)
* Update CONTRIBUTING.md and PR template Signed-off-by: Sachin Sahu <[email protected]> * Add examples in PR template Signed-off-by: Sachin Sahu <[email protected]> * Add examples in CONTRIBUTING.md Signed-off-by: Sachin Sahu <[email protected]> --------- Signed-off-by: Sachin Sahu <[email protected]>
1 parent b9b2f62 commit 2f36f98

File tree

2 files changed

+70
-0
lines changed

2 files changed

+70
-0
lines changed

.github/pull-request-template.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
<!-- Refer to CONTRIBUTING.md for more details and examples.
2+
https://github.com/prometheus/client_golang/blob/main/CONTRIBUTING.md#how-to-fill-the-pr-template
3+
-->
4+
### Describe your PR
5+
6+
7+
### What type of PR is this?
8+
9+
<!-- Format: /kind followed by ONE of the type {fix, bugfix, enhancement, feature, feat, change, release-note-none} -->
10+
11+
12+
### Changelog Entry
13+
```release-note
14+
15+
```
16+
<!-- Briefly describe any USER-FACING changes introduced in your PR. If your change should not appear in the changelog, write NONE. -->

CONTRIBUTING.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Contributing
22

3+
Thank you for contributing to our project! Here are the steps and guidelines to follow when creating a pull request (PR).
4+
35
Prometheus uses GitHub to manage reviews of pull requests.
46

57
* If you have a trivial fix or improvement, go ahead and create a pull request,
@@ -18,3 +20,55 @@ Prometheus uses GitHub to manage reviews of pull requests.
1820
Environments](http://peter.bourgon.org/go-in-production/#formatting-and-style).
1921

2022
* Be sure to sign off on the [DCO](https://github.com/probot/dco#how-it-works)
23+
24+
## How to fill the PR template
25+
26+
### Describe your PR
27+
28+
In this section, provide a clear and concise description of what your PR does. This helps reviewers understand the purpose and context of your changes.
29+
30+
### What type of PR is this?
31+
32+
Indicate the type of PR by adding one of the following options:
33+
34+
- `/kind fix`
35+
- `/kind bugfix`
36+
- `/kind enhancement`
37+
- `/kind feature`
38+
- `/kind feat`
39+
- `/kind change`
40+
- `/kind release-note-none`
41+
42+
If this change should not appear in the changelog, use `/kind release-note-none`.
43+
44+
Example 1:
45+
```
46+
### What type of PR is this?
47+
/kind feature
48+
```
49+
50+
Example 2:
51+
```
52+
### What type of PR is this?
53+
/kind release-note-none
54+
```
55+
56+
### Changelog Entry
57+
58+
Include a brief summary of your change for the changelog. This helps users understand what has been modified, added, or fixed in the project. If your change should not appear in the changelog, write `NONE`. Make sure to add only user-facing changes.
59+
60+
Example 1:
61+
```
62+
### Changelog Entry
63+
```release-note
64+
api: Switch to POST for `LabelNames`.
65+
```
66+
```
67+
68+
Example 2:
69+
```
70+
### Changelog Entry
71+
```release-note
72+
NONE
73+
```
74+
```

0 commit comments

Comments
 (0)