[Merged by Bors] - Add "Changelog" and "Migration Guide" to PR template #4143
Conversation
Added the "Changelog" and "Migration Guide" sections for authors to optionally fill out.
Co-authored-by: Alice Cecile <alice.i.cecile@gmail.com>
Co-authored-by: Alice Cecile <alice.i.cecile@gmail.com>
Should they really go above the objective of the PR? Would this affect how authors view the |
IMO the point of "Objective" is two-fold. First, to link any issues that are closed. Secondly, to help provide stronger context on why the problem is worth solving. These are both valuable, but feel like they're less essential to a casual reader (especially post-merge when browsing changes in release notes) than "here's what changed". I don't feel super strongly about this though 😅 |
|
Another consideration are smaller PRs. If a PR fixes something small like a typo or something similar, do we want to suggest a preference for filling out the template? Such as only filling out the Objective section, or only the Changelog section. Otherwise we might get: (Which isn't inherently bad haha just unnecessary) |
Maybe we add a divider between the two sections and the rest of the template? To further indicate that these are two distinct parts of the PR? And the "real" PR starts in the lower section (objective, solution, etc.) |
Hmm. I've seen this problem occur even now, where the problem is trivial, as is the solution. Maybe it's Problem and Solution that should be optional? |
Well we probably don't want them optional for larger (or even medium-sized) PRs. |
|
For the migration guide I think it should be at the bottom. I don't think it helps that much at getting a quick overview. For the changelog I'm less sure. It's nice to get a quick overview, but a changelog without the full context of the objective isn't necessarily better. |
Co-authored-by: Alice Cecile <alice.i.cecile@gmail.com>
alice-i-cecile
added
the
S-Ready-For-Final-Review
|
bors r+ |
# Objective Context: [Discord Discussion](https://discord.com/channels/691052431525675048/745355529777315850/950532143325519902) Improve the PR template by adding "Changelog" and "Migration Guide" sections. These sections should hopefully help speed up the review/merge process, as well as help make release notes and migration guides. ## Solution Added the "Changelog" section template which suggests listing out the changes of the PR. This also acts as a sort of tl;dr for reviewers (especially for larger PRs). Added the "Migration Guide" section template which suggests describing how a user might need to migrate their codebase to account for the changes by the PR. This also helps authors/contributors keep the end-user in mind when adding or changing the API. Both sections are optional— an author does not _need_ to fill these out. Hopefully they will, though, as it provides a handful of really great benefits. Co-authored-by: MrGVSV <49806985+MrGVSV@users.noreply.github.com>
bors
bot
changed the title
# Objective Context: [Discord Discussion](https://discord.com/channels/691052431525675048/745355529777315850/950532143325519902) Improve the PR template by adding "Changelog" and "Migration Guide" sections. These sections should hopefully help speed up the review/merge process, as well as help make release notes and migration guides. ## Solution Added the "Changelog" section template which suggests listing out the changes of the PR. This also acts as a sort of tl;dr for reviewers (especially for larger PRs). Added the "Migration Guide" section template which suggests describing how a user might need to migrate their codebase to account for the changes by the PR. This also helps authors/contributors keep the end-user in mind when adding or changing the API. Both sections are optional— an author does not _need_ to fill these out. Hopefully they will, though, as it provides a handful of really great benefits. Co-authored-by: MrGVSV <49806985+MrGVSV@users.noreply.github.com>
# Objective Context: [Discord Discussion](https://discord.com/channels/691052431525675048/745355529777315850/950532143325519902) Improve the PR template by adding "Changelog" and "Migration Guide" sections. These sections should hopefully help speed up the review/merge process, as well as help make release notes and migration guides. ## Solution Added the "Changelog" section template which suggests listing out the changes of the PR. This also acts as a sort of tl;dr for reviewers (especially for larger PRs). Added the "Migration Guide" section template which suggests describing how a user might need to migrate their codebase to account for the changes by the PR. This also helps authors/contributors keep the end-user in mind when adding or changing the API. Both sections are optional— an author does not _need_ to fill these out. Hopefully they will, though, as it provides a handful of really great benefits. Co-authored-by: MrGVSV <49806985+MrGVSV@users.noreply.github.com>
Objective
Context: Discord Discussion
Improve the PR template by adding "Changelog" and "Migration Guide" sections. These sections should hopefully help speed up the review/merge process, as well as help make release notes and migration guides.
Solution
Added the "Changelog" section template which suggests listing out the changes of the PR. This also acts as a sort of tl;dr for reviewers (especially for larger PRs).
Added the "Migration Guide" section template which suggests describing how a user might need to migrate their codebase to account for the changes by the PR. This also helps authors/contributors keep the end-user in mind when adding or changing the API.
Both sections are optional— an author does not need to fill these out. Hopefully they will, though, as it provides a handful of really great benefits.