Skip to content

Commit

Permalink
change: [M3-8857] - Update PULL_REQUEST_TEMPLATE (Part 2) (linode#11236)
Browse files Browse the repository at this point in the history
* Make updates discussed to PR template during retro

* Add changeset
  • Loading branch information
mjac0bs authored Nov 12, 2024
1 parent dd212ec commit 3450d7c
Show file tree
Hide file tree
Showing 2 changed files with 45 additions and 19 deletions.
59 changes: 40 additions & 19 deletions docs/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,20 @@
## Description πŸ“

Highlight the Pull Request's context and intentions.

## Changes πŸ”„
List any change relevant to the reviewer.

List any change(s) relevant to the reviewer.

- ...
- ...

## Target release date πŸ—“οΈ

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.

## Preview πŸ“·

**Include a screenshot or screen recording of the change.**

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

### Prerequisites

(How to setup test environment)

- ...
- ...

### Reproduction steps

(How to reproduce the issue, if applicable)
- ...
- ...

- [ ] ...
- [ ] ...

### Verification steps

(How to verify changes)
- ...
- ...

## As an Author I have considered πŸ€”
- [ ] ...
- [ ] ...

## As an Author, I have considered πŸ€”

*Check all that apply*
- πŸ‘€ Doing a self review
- ❔ Our [contribution guidelines](https://github.com/linode/manager/blob/develop/docs/CONTRIBUTING.md)
- 🀏 Splitting feature into small PRs
- βž• Adding a [changeset](https://github.com/linode/manager/blob/develop/docs/CONTRIBUTING.md#writing-a-changeset)
- πŸ§ͺ Providing/improving test coverage
- πŸ” Removing all sensitive information from the code and PR description
- 🚩 Using a feature flag to protect the release
- πŸ‘£ Providing comprehensive reproduction steps
- πŸ“‘ Providing or updating our documentation
- πŸ•› Scheduling a pair reviewing session
- πŸ“± Providing mobile support
- β™Ώ Providing accessibility support

- [ ] πŸ‘€ Doing a self review
- [ ] ❔ Our [contribution guidelines](https://github.com/linode/manager/blob/develop/docs/CONTRIBUTING.md)
- [ ] 🀏 Splitting feature into small PRs
- [ ] βž• Adding a [changeset](https://github.com/linode/manager/blob/develop/docs/CONTRIBUTING.md#writing-a-changeset)
- [ ] πŸ§ͺ Providing/Improving test coverage
- [ ] πŸ” Removing all sensitive information from the code and PR description
- [ ] 🚩 Using a feature flag to protect the release
- [ ] πŸ‘£ Providing comprehensive reproduction steps
- [ ] πŸ“‘ Providing or updating our documentation
- [ ] πŸ•› Scheduling a pair reviewing session
- [ ] πŸ“± Providing mobile support
- [ ] β™Ώ Providing accessibility support
<br/>

- [ ] I have read and considered all applicable items listed above.

## As an Author, before moving this PR from Draft to Open, I confirmed βœ…

- [ ] All unit tests are passing
- [ ] TypeScript compilation succeeded without errors
- [ ] Code passes all linting rules

---

## Commit message and pull request title format standards

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

**Commit Types:**

- `feat`: New feature for the user (not a part of the code, or ci, ...).
- `fix`: Bugfix for the user (not a fix to build something, ...).
- `change`: Modifying an existing visual UI instance. Such as a component or a feature.
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@linode/manager": Tech Stories
---

Update PULL_REQUEST_TEMPLATE ([#11219](https://github.com/linode/manager/pull/11219), [#11236](https://github.com/linode/manager/pull/11236))

0 comments on commit 3450d7c

Please sign in to comment.