Skip to content

Commit 3450d7c

Browse files
authored
change: [M3-8857] - Update PULL_REQUEST_TEMPLATE (Part 2) (#11236)
* Make updates discussed to PR template during retro * Add changeset
1 parent dd212ec commit 3450d7c

File tree

2 files changed

+45
-19
lines changed

2 files changed

+45
-19
lines changed

docs/PULL_REQUEST_TEMPLATE.md

Lines changed: 40 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,20 @@
11
## Description 📝
2+
23
Highlight the Pull Request's context and intentions.
34

45
## Changes 🔄
5-
List any change relevant to the reviewer.
6+
7+
List any change(s) relevant to the reviewer.
8+
69
- ...
710
- ...
811

912
## Target release date 🗓️
13+
1014
Please specify a release date (and environment, if applicable) to guarantee timely review of this PR. If exact date is not known, please approximate and update it as needed.
1115

1216
## Preview 📷
17+
1318
**Include a screenshot or screen recording of the change.**
1419

1520
:lock: Use the [Mask Sensitive Data](https://cloud.linode.com/profile/settings) setting for security.
@@ -23,38 +28,53 @@ Please specify a release date (and environment, if applicable) to guarantee time
2328
## How to test 🧪
2429

2530
### Prerequisites
31+
2632
(How to setup test environment)
33+
2734
- ...
2835
- ...
2936

3037
### Reproduction steps
38+
3139
(How to reproduce the issue, if applicable)
32-
- ...
33-
- ...
40+
41+
- [ ] ...
42+
- [ ] ...
3443

3544
### Verification steps
45+
3646
(How to verify changes)
37-
- ...
38-
- ...
3947

40-
## As an Author I have considered 🤔
48+
- [ ] ...
49+
- [ ] ...
50+
51+
## As an Author, I have considered 🤔
4152

42-
*Check all that apply*
53+
- 👀 Doing a self review
54+
- ❔ Our [contribution guidelines](https://github.com/linode/manager/blob/develop/docs/CONTRIBUTING.md)
55+
- 🤏 Splitting feature into small PRs
56+
- ➕ Adding a [changeset](https://github.com/linode/manager/blob/develop/docs/CONTRIBUTING.md#writing-a-changeset)
57+
- 🧪 Providing/improving test coverage
58+
- 🔐 Removing all sensitive information from the code and PR description
59+
- 🚩 Using a feature flag to protect the release
60+
- 👣 Providing comprehensive reproduction steps
61+
- 📑 Providing or updating our documentation
62+
- 🕛 Scheduling a pair reviewing session
63+
- 📱 Providing mobile support
64+
- ♿ Providing accessibility support
4365

44-
- [ ] 👀 Doing a self review
45-
- [ ] ❔ Our [contribution guidelines](https://github.com/linode/manager/blob/develop/docs/CONTRIBUTING.md)
46-
- [ ] 🤏 Splitting feature into small PRs
47-
- [ ] ➕ Adding a [changeset](https://github.com/linode/manager/blob/develop/docs/CONTRIBUTING.md#writing-a-changeset)
48-
- [ ] 🧪 Providing/Improving test coverage
49-
- [ ] 🔐 Removing all sensitive information from the code and PR description
50-
- [ ] 🚩 Using a feature flag to protect the release
51-
- [ ] 👣 Providing comprehensive reproduction steps
52-
- [ ] 📑 Providing or updating our documentation
53-
- [ ] 🕛 Scheduling a pair reviewing session
54-
- [ ] 📱 Providing mobile support
55-
- [ ] ♿ Providing accessibility support
66+
<br/>
67+
68+
- [ ] I have read and considered all applicable items listed above.
69+
70+
## As an Author, before moving this PR from Draft to Open, I confirmed ✅
71+
72+
- [ ] All unit tests are passing
73+
- [ ] TypeScript compilation succeeded without errors
74+
- [ ] Code passes all linting rules
5675

5776
---
77+
5878
## Commit message and pull request title format standards
5979

6080
> **Note**: Remove this section before opening the pull request
@@ -63,6 +83,7 @@ Please specify a release date (and environment, if applicable) to guarantee time
6383
`<commit type>: [JIRA-ticket-number] - <description>`
6484

6585
**Commit Types:**
86+
6687
- `feat`: New feature for the user (not a part of the code, or ci, ...).
6788
- `fix`: Bugfix for the user (not a fix to build something, ...).
6889
- `change`: Modifying an existing visual UI instance. Such as a component or a feature.
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
"@linode/manager": Tech Stories
3+
---
4+
5+
Update PULL_REQUEST_TEMPLATE ([#11219](https://github.com/linode/manager/pull/11219), [#11236](https://github.com/linode/manager/pull/11236))

0 commit comments

Comments
 (0)