Add development approach to PR template#13730
Conversation
See test results for failed build of commit 11ee94ef80 |
feerrenrut
left a comment
There was a problem hiding this comment.
It might be worth clarifying that Description of how this pull request fixes the issue: is now intended to be user / use-case / ux focused.
Originally summary of the issue was meant to be use-case / ux need focused, and Description of how this pull request fixes the issue was meant to be development focused. Note the suggestion for links to external information.
I'm happy to have 3 sections:
- This is a summary of use-case / problem statement.
- This is the UX I've implemented to fix it.
- This is a technical description of how I addressed it.
| This helps others to have the same background as you and learn from this work. | ||
|
|
||
| ### Description of development approach | ||
| Provide a description of the development approach followed. |
There was a problem hiding this comment.
The way this is written currently sounds like it's asking for an answer like "test driven development", whereas I think you want a technical overview, answering questions like:
- How does data flow?
- What components are involved and how do they relate to each other?
- Example data to be processed?
Providing an example could help.
There was a problem hiding this comment.
I've changed the terminology from "development approach" to "technical changes".
I've also added a simple example.
Link to issue number:
None
Summary of the issue:
In order to aid reviewing complex pull requests, having a description of the development approach is helpful.
Often this is implicitly included in "Description of how this pull request fixes the issue", however this is also used as a high level summary of the user facing changes. A separation of concerns is needed.
Description of how this pull request fixes the issue:
Adds this information to the PR template and explanation.
Testing strategy:
Known issues with pull request:
n/a
Change log entries:
n/a
Code Review Checklist: