Skip to content

Commit 8f3d5f7

Browse files
committed
Clearer PR template
1 parent a01f69d commit 8f3d5f7

File tree

1 file changed

+40
-18
lines changed

1 file changed

+40
-18
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 40 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,55 @@
1-
**What this PR does / why we need it**:
2-
3-
**Which issue(s) this PR fixes**:
41
<!--
5-
Usage: `Fixes #<issue number>`, or `Fixes (paste link of issue)`.
2+
If this pull request is just an idea or POC, or is not ready for review, select "Create draft pull request" (https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests#draft-pull-requests)
3+
instead of "Create pull request"
64
-->
7-
Fixes #
85

9-
**Describe testing done for PR**:
6+
### What this PR does / why we need it
7+
8+
### Which issue(s) this PR fixes
109
<!--
11-
Example: Created vSphere workload cluster to verify change.
10+
Usage: Fixes #<issue number>.
11+
12+
Unless the PR is for a trivial change (e.g. fixing a typo), consider opening an issue first
13+
(and reference it here) so that the problem the PR addresses can be discussed independently of
14+
the solutions proposed by this PR.
1215
-->
1316

14-
**Special notes for your reviewer**:
17+
Fixes #
18+
19+
### Describe testing done for PR
20+
21+
<!-- Example: Created vSphere workload cluster to verify change. -->
1522

16-
**Release note**:
23+
### Release note
1724
<!--
18-
See https://github.com/vmware-tanzu/tanzu-framework/blob/main/docs/release/release-notes.md#does-my-pull-request-need-a-release-note
19-
for more details.
25+
See https://github.com/vmware-tanzu/tanzu-framework/blob/main/docs/release/release-notes.md#does-my-pull-request-need-a-release-note
26+
for more details.
2027
21-
Please add a short text in the release-note block below (or "NONE" if not applicable)
22-
if there is anything in this PR that is worthy of mention in the next release.
28+
Please add a short text (limit to 1 to 2 sentences if possible) in the release-note block below if
29+
there is anything in this PR that is worthy of mention in the next release.
2330
-->
2431
```release-note
2532
2633
```
27-
**New PR Checklist**
2834

29-
- [ ] Ensure PR contains only public links or terms
35+
### PR Checklist
36+
37+
<!-- Please acknowlege by checking that they are being followed -->
38+
39+
- [ ] Squash the commits into one or a small number of logical ones
40+
<!--
41+
This repository adopts a linear git history model where no merge commits are necessary. To
42+
keep the commit history tidy, it is recommended that authors be responsible for the decision
43+
whether to sqaush the PR's changes into a single commit (and tidy up the commit message in the
44+
process) or organizing them into a small number of self-contained and meaningful ones.
45+
-->
3046
- [ ] Use good commit [messages](https://github.com/vmware-tanzu/tanzu-framework/blob/main/CONTRIBUTING.md)
31-
- [ ] Squash the commits in this branch before merge to preserve our git history
32-
- [ ] If this PR is just an idea or POC, use a [Draft PR](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests#draft-pull-requests) instead of a full PR
33-
- [ ] Add appropriate [kind label](../docs/release/kind-labels.md) according to what type of issue is being addressed.
47+
- [ ] Ensure PR contains contains terms all contributors can understand and links all contributors can access
48+
49+
50+
### Additional information
51+
52+
#### Special notes for your reviewer
53+
54+
<!-- Add notes to that can aid in the review process, or leave blank -->
55+

0 commit comments

Comments
 (0)