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.
What is the goal of this PR?
{ 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:
describe the impact of the change in this PR to the user of this repository (e.g. end user, contributor, developer).
describe the new product behaviour in present tense, and the old behaviour and how it's been changed in past tense
.
Use the Royal We: "We" made changes, not "I" made changes. }
What are the changes implemented in this PR?
{ 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:
its responsibility,
how it's expected to behave, and
how it relates to the adjacent methods/classes/packages it interacts with.
This would allow the review 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'. }
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.
What is the goal of this PR?
{ 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:
What are the changes implemented in this PR?
{ 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:
This would allow the review 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'. }