Skip to content

Commit c026607

Browse files
Update PULL_REQUEST_TEMPLATE.md
1 parent 90a4362 commit c026607

File tree

1 file changed

+11
-3
lines changed

1 file changed

+11
-3
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,17 @@
1-
Please replace every line in curly brackets { like this } with an appropriate description, and remove this line.
1+
**For the title of this PR:** please follow the grammatical rules of a usual publication title, without capitalisation (except for the first letter). Thus, the title should NOT CONTAIN CODE: no dots, no parentheses, no backticks, no brackets, etc. It needs to be distinctive (not detailed) and succinct (not lengthy). Details of this PR will go in the description. **For the description of this PR:** please replace every line in curly brackets ( { like this } ) with an appropriate description following the guidance. Finally, **please remove this paragraph**.
22

33
## What is the goal of this PR?
44

5-
{ Please describe the goal of this PR, why they are valuable to achieve, and reference the related GitHub issues. }
5+
{ In the form of a paragraph (only use bullet points if strictly necessary), please describe the goal of this PR, why they are valuable to achieve, and reference the related GitHub issues. This section will be automatically compiled into the release notes, so please:
6+
- describe the impact of the change in this PR to the _user_ of this repository (e.g. end user, contributor, developer).
7+
- describe the new product behaviour in _present tense_, and the old behaviour and how it's been changed in _past tense_.
8+
- Use the _Royal We_: _"We"_ made changes, not _"I"_ made changes. }
69

710
## What are the changes implemented in this PR?
811

9-
{ Please explain what you implemented, why your changes are the best way to achieve the goal(s) above, and reference the GitHub issues to be automatically closed, such like 'closes #number'. }
12+
{ Please explain what you implemented, why your changes are the best way to achieve the goal(s) above. Please describe every method, class and package, by explaining:
13+
- its responsibility,
14+
- how it's expected to behave, and
15+
- how it relates to the adjacent methods/classes/packages it interacts with.
16+
17+
This would allow the reviewer to understand your intentions in the code much better. If you're adding new classes, make sure these explanations are also included in the class header comments. Last but not least, please reference the GitHub issues to be automatically closed, such like 'closes #number'. }

0 commit comments

Comments
 (0)