Skip to content

Commit 5db9a73

Browse files
authored
Rework and simplify PR template (#1689)
A reworking of our GitHub PR template. - Removed "Type of Change" as discussed. - Reworded almost everything to a length that is more likely to be read. I think I preserved all the critical details. - Restructured "(issue)" to give it some extra prominence and so we can replace it with only Double-click + Paste - Merged the two testing sections - Made everything that is intended to be replaced italic - Turned QA environment url into a link, so it's obvious that it's a real domain/url - Left the checklist alone 😉
1 parent 1fcf680 commit 5db9a73

File tree

1 file changed

+7
-21
lines changed

1 file changed

+7
-21
lines changed

.github/pull_request_template.md

Lines changed: 7 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,12 @@
1-
Fixes # (issue)
1+
### Fixes #_issue_
22

33
## Description
44

5-
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
6-
7-
### Type of Change
8-
9-
Only keep lines below that describe this change, then delete the rest.
10-
11-
- Bug fix (non-breaking change which fixes an issue)
12-
- New feature (non-breaking change which adds functionality)
13-
- Breaking change (fix or feature that would cause existing functionality to not work as expected)
14-
- This change requires a documentation update
15-
- migration required (a model change requiring a mongodb script or migration script)
16-
- UI change
5+
_A summary of the change including motivation and context._
176

187
## Screenshots
198

20-
Please provide screenshots / animations for any change that involves the UI. Please provide animations to demonstrate user interaction / behavior changes
9+
_Demonstrate any UI / behavioral changes with screenshots or animations._
2110

2211
## Checklist
2312

@@ -28,13 +17,10 @@ Please provide screenshots / animations for any change that involves the UI. Ple
2817
- [ ] I have added tests that prove my fix is effective or that my feature works
2918
- [ ] I have enabled auto-merge (optional)
3019

31-
## How to test
20+
## QA testing
3221

33-
Please describe how to test and/or verify your changes. Provide instructions so we can reproduce. Please also provide relevant test data as necessary. These instructions will be used for QA testing below.
22+
Testers, use the following instructions on [qa.languageforge.org](https://qa.languageforge.org). Post your findings as a comment and include any meaningful screenshots, etc.
3423

35-
- Test A
36-
- Test B
37-
38-
## qa.languageforge.org testing
24+
_Describe how to verify your changes and provide any necessary test data._
3925

40-
Testers should add his/her findings to end of the PR in a comment and include screenshots, files, etc that are beneficial.
26+
- Test A

0 commit comments

Comments
 (0)