Skip to content

Commit 692c682

Browse files
authored
Refine copy for PR template and add a release-note code fence (#1678)
Signed-off-by: Stephen Augustus <foo@auggie.dev>
1 parent 504f134 commit 692c682

File tree

1 file changed

+35
-8
lines changed

1 file changed

+35
-8
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 35 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,48 @@
1-
* **Please check if the PR fulfills these requirements**
2-
- [ ] Tests for the changes have been added (for bug fixes / features)
3-
- [ ] PR title follows the guidelines defined in https://github.com/ossf/scorecard/blob/main/CONTRIBUTING.md#pr-process
1+
#### What kind of change does this PR introduce?
42

5-
* **What kind of change does this PR introduce?** (Bug fix, feature, docs update, ...)
3+
(Is it a bug fix, feature, docs update, something else?)
64

5+
- [ ] PR title follows the guidelines defined in our [pull request documentation](https://github.com/ossf/scorecard/blob/main/CONTRIBUTING.md#pr-process)
76

7+
#### What is the current behavior?
88

9-
* **What is the current behavior?** (You can also link to an open issue here)
9+
#### What is the new behavior (if this is a feature change)?**
1010

11+
- [ ] Tests for the changes have been added (for bug fixes/features)
1112

13+
#### Which issue(s) this PR fixes
1214

13-
* **What is the new behavior (if this is a feature change)?**
15+
<!--
16+
*Automatically closes linked issue when PR is merged.
17+
Usage: `Fixes #<issue number>`, or `Fixes (paste link of issue)`.
1418
19+
Fixes #
1520
21+
or
1622
17-
* **Does this PR introduce a breaking change?** (What changes might users need to make in their application due to this PR?)
23+
NONE
24+
-->
1825

26+
#### Special notes for your reviewer
1927

28+
#### Does this PR introduce a user-facing change?
2029

21-
* **Other information**:
30+
For user-facing changes, please add a concise, human-readable release note to
31+
the `release-note`
32+
33+
(In particular, describe what changes users might need to make in their
34+
application as a result of this pull request.)
35+
36+
<!--
37+
If no, just write "NONE" in the release-note block below.
38+
If yes, a release note is required:
39+
Enter your extended release note in the block below.
40+
If the PR requires additional action from users switching to the new release,
41+
include the string "ACTION REQUIRED".
42+
43+
For more information on release notes see: https://git.k8s.io/release/cmd/release-notes/README.md
44+
-->
45+
46+
```release-note
47+
48+
```

0 commit comments

Comments
 (0)