At a high-level, describe this request adds/changes/improves/fixes
You don't need to describe every change but each request should have an overarching theme
Don't mix a lot of big unrelated modifications in one request
Closes #x (each request should address an open issue. Open an issue first to discuss what you'd like to change.)
Motivation
Describe why this request is needed/good/useful etc.
If this information is already captured in detail in the related issue, just provide a high-level statement and link to the issue.
Implementation
While your code changes can be seen in the diff between branches, it may not capture why certain choices were made, what else had had been tried unsuccessfully etc.
Also, depending on the size of the request, many changes may be difficult to read through.
Consider this section as a way to provide context, commentary and an introduction to the code you've written.
At minimum, you should address the bullet points you listed in the summary above in some capacity to guide the reviewer on where to look.
Summary of Changes
Closes #x (each request should address an open issue. Open an issue first to discuss what you'd like to change.)
Motivation
Describe why this request is needed/good/useful etc. If this information is already captured in detail in the related issue, just provide a high-level statement and link to the issue.
Implementation
While your code changes can be seen in the diff between branches, it may not capture why certain choices were made, what else had had been tried unsuccessfully etc. Also, depending on the size of the request, many changes may be difficult to read through. Consider this section as a way to provide context, commentary and an introduction to the code you've written. At minimum, you should address the bullet points you listed in the summary above in some capacity to guide the reviewer on where to look.