diff --git a/.github/pull-request-template.md b/.github/pull-request-template.md new file mode 100644 index 000000000..d3ab27115 --- /dev/null +++ b/.github/pull-request-template.md @@ -0,0 +1,16 @@ + +### Describe your PR + + +### What type of PR is this? + + + + +### Changelog Entry +```release-note + +``` + diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e015a85cb..d068597c9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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, @@ -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: + +- `/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 + ``` +``` \ No newline at end of file