Skip to content

Commit

Permalink
docs: Updating PR template (#7578)
Browse files Browse the repository at this point in the history
## **Description**
Currently the PR template although comprehensive, could be improved with
the intention of easing engineer workflow by removing italics,
rearranging the sections and making the author checklist more concise
and use the same language as the template itself.

## **Manual testing steps**

1. Read the PR template
2. Imagine filling it out
3. Do you feel it would help or hinder when creating a PR?
4. Comment with input

## **Screenshots/Recordings**

### **Before**

![Screenshot 2023-10-23 at 12 12 49
PM](https://github.com/MetaMask/metamask-mobile/assets/8112138/a0389bc4-62b5-4b25-9a77-94c0c9ff4ada)


### **After**

![Screenshot 2023-10-23 at 12 12 34
PM](https://github.com/MetaMask/metamask-mobile/assets/8112138/0561a321-7956-4d71-a9b3-3143d2e22764)


## **Related issues**

- Extension PR MetaMask/metamask-extension#21377
- Slack thread
https://consensys.slack.com/archives/G1L7H42BT/p1697208312544229

## **Pre-merge author checklist**

- [x] I’ve followed [MetaMask Coding
Standards](https://github.com/MetaMask/metamask-extension/blob/develop/.github/guidelines/CODING_GUIDELINES.md).
- [x] I've clearly explained:
  - [x] What problem this PR is solving.
  - [x] How this problem was solved.
  - [x] How reviewers can test my changes.
- [ ] I’ve indicated what issue this PR is linked to: Fixes #???
- [x] I’ve included tests if applicable.
- [x] I’ve documented any added code.
- [x] I’ve applied the right labels on the PR (see [labeling
guidelines](https://github.com/MetaMask/metamask-extension/blob/develop/.github/guidelines/LABELING_GUIDELINES.md)).
- [x] I’ve properly set the pull request status:
  - [x] In case it's not yet "ready for review", I've set it to "draft".
- [x] In case it's "ready for review", I've changed it from "draft" to
"non-draft".

## **Pre-merge reviewer checklist**

- [ ] I've manually tested the PR (e.g. pull and build branch, run the
app, test code being changed).
- [ ] I confirm that this PR addresses all acceptance criteria described
in the ticket it closes and includes the necessary testing evidence such
as recordings and or screenshots.
  • Loading branch information
georgewrmarshall authored Oct 23, 2023
1 parent e6e53a5 commit 5a4acf6
Showing 1 changed file with 22 additions and 20 deletions.
42 changes: 22 additions & 20 deletions .github/pull-request-template.md
Original file line number Diff line number Diff line change
@@ -1,40 +1,42 @@
## **Description**
_Write a short description of the changes included in this pull request, also include relevant motivation and context. Have in mind the following questions:_
_1. What is the reason for the change?_
_2. What is the improvement/solution?_

<!--
Write a short description of the changes included in this pull request, also include relevant motivation and context. Have in mind the following questions:
1. What is the reason for the change?
2. What is the improvement/solution?
-->

## **Related issues**

Fixes: #

## **Manual testing steps**

_1. Step1:_
_2. Step2:_
_3. ..._
1. Go to this page...
2.
3.

## **Screenshots/Recordings**

_If applicable, add screenshots and/or recordings to visualize the before and after of your change._
<!-- If applicable, add screenshots and/or recordings to visualize the before and after of your change. -->

### **Before**

_[screenshot]_
<!-- [screenshots/recordings] -->

### **After**

_[screenshot]_

## **Related issues**

_Fixes #???_
<!-- [screenshots/recordings] -->

## **Pre-merge author checklist**

- [ ] I’ve followed [MetaMask Coding Standards](https://github.com/MetaMask/metamask-mobile/blob/main/.github/guidelines/CODING_GUIDELINES.md).
- [ ] I've clearly explained:
- [ ] What problem this PR is solving.
- [ ] How this problem was solved.
- [ ] How reviewers can test my changes.
- [ ] I’ve indicated what issue this PR is linked to: Fixes #???
- [ ] I’ve included tests if applicable.
- [ ] I’ve documented any added code.
- [ ] I've clearly explained what problem this PR is solving and how it is solved.
- [ ] I've linked related issues
- [ ] I've included manual testing steps
- [ ] I've included screenshots/recordings if applicable
- [ ] I’ve included tests if applicable
- [ ] I’ve documented my code using [JSDoc](https://jsdoc.app/) format if applicable
- [ ] I’ve applied the right labels on the PR (see [labeling guidelines](https://github.com/MetaMask/metamask-mobile/blob/main/.github/guidelines/LABELING_GUIDELINES.md)).
- [ ] I’ve properly set the pull request status:
- [ ] In case it's not yet "ready for review", I've set it to "draft".
Expand Down

0 comments on commit 5a4acf6

Please sign in to comment.