Skip to content

Commit ec4de3d

Browse files
authored
Add minor hints to PR template (#1748)
* Add minor hints to PR template * Change wording for Description
1 parent 4d5575b commit ec4de3d

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

.github/pull_request_template.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,11 @@ Check that the title contains
2525

2626
## Description
2727

28-
- Mention the related issue (_**"Fixes #..."**_) or describe why you've made the changes.
29-
- Add useful info for your reviewer or another contributor.
28+
Fixes # (issue)
29+
30+
Add more info _if needed_:
31+
* context/purpose for implementing changes
32+
* detailed description of the changes made
3033

3134
## How to test
3235

@@ -46,11 +49,13 @@ If this is your case, share the detailed _manual scenarios_ that help to verify
4649

4750
## Self-check list
4851

49-
Check off the item if the statement is true:
52+
Check off the item if the statement is true. Hint: [x] is a marked item.
53+
54+
Please do not delete the list or its items.
5055

5156
- [ ] I've set the proper **labels** for my PR (at least, for category and component).
5257
- [ ] PR **title** and **description** are clear and intelligible.
53-
- [ ] I've added enough **comments**, particularly in hard-to-understand areas.
58+
- [ ] I've added enough **comments** to my code, particularly in hard-to-understand areas.
5459
- [ ] The functionality I've repaired, changed or added is covered with **automated tests**.
5560
- [ ] **Manual tests** have been provided optionally.
5661
- [ ] The **documentation** for the functionality I've been working on is up-to-date.

0 commit comments

Comments
 (0)