Commit graph

5 commits

Author SHA1 Message Date
Rob Parrett
af63d4048a Let contributors know it's okay to delete optional template sections (#4498)
# Objective

We are currently asking contributors to "skip" optional sections, which is a bit confusing. "Skip" can be taken to mean that you should "leave that section alone" and result in these bits of template being left in the PR description.

## Solution

Let contributors know that it's okay to delete the section if it's not needed.
2022-04-16 18:57:51 +00:00
MrGVSV
c1a2378790 Add "Changelog" and "Migration Guide" to PR template (#4143)
# 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>
2022-03-16 20:48:42 +00:00
Nathan Ward
c4b8210a7c Add PR Template (#2272)
This is a first step at addressing #2256 via adding a pr template.
2021-06-02 21:07:56 +00:00
Carter Anderson
5df6804daf
Delete pull_request_template.md 2020-10-17 12:25:20 -07:00
Logan Magee
90ea5b1e6b
Add issue and pull request templates (#551) 2020-10-15 13:47:23 -07:00