-
Notifications
You must be signed in to change notification settings - Fork 9
/
PULL_REQUEST_TEMPLATE.txt
33 lines (21 loc) · 1.38 KB
/
PULL_REQUEST_TEMPLATE.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
### ⚠️ TEMPLATE ⚠️
**Template for GitHub PR descriptions. Use it as a guide on how to describe your work.**
### :pushpin: References
**Issues:**
* Fixes #1
### :tophat: What is the goal?
* Here you would describe the PR goals. Just the stuff we need to implement for the fix / feature and a simple rationale.
* It could contain many check points if needed. We have no restrictions at all on the content of each section itself.
### 💻 How is it being implemented?
Here we use to include all the relevant things implemented and also rationale, aclarations / disclaimers etc related to the approach you used.
* Stuff implemented 1
* Stuff implemented 2
* Stuff implemented 3
### 🖼 Screenshots or Gifs
We include all the media files to give some context about what's being implemented or fixed. It's not mandatory to upload screenshots or gifts, but for most of the cases it becomes really handy to get into the scope of the feature / bug being fixed. It's also REALLY useful for UI related PRs.
### 📱 How to Test
Here we use to add the steps to manually test the PR. Here you have some sample checks:
* Install the branch and click on "+" on toolbar under rides tab.
* Click on one ride.
* New blank screen with "Duplicate Ride title" should appear on screen.