Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add PR template for changelog automation #1517

Merged
merged 3 commits into from
May 30, 2024
Merged

Add PR template for changelog automation #1517

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
334f0f7
Update CONTRIBUTING.md and PR template
SachinSahu431 May 19, 2024
c277fe4
Add examples in PR template
SachinSahu431 May 22, 2024
815964e
Add examples in CONTRIBUTING.md
SachinSahu431 May 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions .github/pull-request-template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
<!-- Refer to CONTRIBUTING.md for more details and examples.
https://github.com/prometheus/client_golang/blob/main/CONTRIBUTING.md#how-to-fill-the-pr-template
-->
### Describe your PR


### What type of PR is this?

<!-- Format: /kind followed by ONE of the type {fix, bugfix, enhancement, feature, feat, change, release-note-none} -->
SachinSahu431 marked this conversation as resolved.
Show resolved Hide resolved


### Changelog Entry
SachinSahu431 marked this conversation as resolved.
Show resolved Hide resolved
```release-note

```
<!-- Briefly describe any USER-FACING changes introduced in your PR. If your change should not appear in the changelog, write NONE. -->
54 changes: 54 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Contributing

Thank you for contributing to our project! Here are the steps and guidelines to follow when creating a pull request (PR).

Prometheus uses GitHub to manage reviews of pull requests.

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

* Be sure to sign off on the [DCO](https://github.com/probot/dco#how-it-works)

## How to fill the PR template

### Describe your PR

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.

### What type of PR is this?

Indicate the type of PR by adding one of the following options:
SachinSahu431 marked this conversation as resolved.
Show resolved Hide resolved

- `/kind fix`
- `/kind bugfix`
- `/kind enhancement`
- `/kind feature`
- `/kind feat`
- `/kind change`
- `/kind release-note-none`

If this change should not appear in the changelog, use `/kind release-note-none`.

Example 1:
```
### What type of PR is this?
/kind feature
```

Example 2:
```
### What type of PR is this?
/kind release-note-none
```

### Changelog Entry

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.

Example 1:
```
### Changelog Entry
```release-note
api: Switch to POST for `LabelNames`.
```
```

Example 2:
```
### Changelog Entry
```release-note
NONE
```
```
Loading