From d84ce75c5ace7f798d1b9e72447bdc3835d1dc77 Mon Sep 17 00:00:00 2001 From: MrGVSV Date: Mon, 7 Mar 2022 15:24:46 -0800 Subject: [PATCH 1/7] Updated PR template with new sections Added the "Changelog" and "Migration Guide" sections for authors to optionally fill out. --- .github/pull_request_template.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 7892ff102f8e0..399a6ff2f373a 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -6,3 +6,12 @@ ## Solution - Describe the solution used to achieve the objective above. + +## Changelog + +- List a general overview of the changes made by this PR +- Try to be concise. If more detail is needed for a particular change, consider adding it to the "Solution" section + +## Migration Guide + +- If this PR affects the public API, describe how a user might need to migrate their code to support these changes \ No newline at end of file From d0d38640869628a496be2bce689c0f721fa3d643 Mon Sep 17 00:00:00 2001 From: MrGVSV <49806985+MrGVSV@users.noreply.github.com> Date: Mon, 7 Mar 2022 15:48:37 -0800 Subject: [PATCH 2/7] Apply suggestions from code review Co-authored-by: Alice Cecile --- .github/pull_request_template.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 399a6ff2f373a..ebd59affa5468 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -7,11 +7,12 @@ - Describe the solution used to achieve the objective above. -## Changelog +## \[ Optional \] Changelog -- List a general overview of the changes made by this PR -- Try to be concise. If more detail is needed for a particular change, consider adding it to the "Solution" section +- What changed as a result of this PR? +- Stick to one or two sentences. If more detail is needed for a particular change, consider adding it to the "Solution" section + - If you can't summarize the work your change may be unreasonably large / unrelated. Consider splitting your PR to make it easier to review and merge! -## Migration Guide +## \[Optional\] Migration Guide - If this PR affects the public API, describe how a user might need to migrate their code to support these changes \ No newline at end of file From 2133d76df681c7f8e10f305080e17e96d3d099ea Mon Sep 17 00:00:00 2001 From: MrGVSV <49806985+MrGVSV@users.noreply.github.com> Date: Mon, 7 Mar 2022 15:53:38 -0800 Subject: [PATCH 3/7] Apply suggestions from code review Co-authored-by: Alice Cecile --- .github/pull_request_template.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index ebd59affa5468..eda30abbd24cc 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -15,4 +15,6 @@ ## \[Optional\] Migration Guide -- If this PR affects the public API, describe how a user might need to migrate their code to support these changes \ No newline at end of file +- If this PR is a breaking change (relative to the last release of Bevy), describe how a user might need to migrate their code to support these changes +- Simply adding new functionality is not a breaking change. +- Fixing behavior that was definitely a bug, rather than a questionable design choice is not a breaking change. \ No newline at end of file From 2025f9afacfbaa3accf677f3f33abf0db8056d43 Mon Sep 17 00:00:00 2001 From: MrGVSV Date: Mon, 7 Mar 2022 16:02:00 -0800 Subject: [PATCH 4/7] Specified optional sub-headings to Changelog --- .github/pull_request_template.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index ebd59affa5468..8891d5ba9b82c 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -10,8 +10,9 @@ ## \[ Optional \] Changelog - What changed as a result of this PR? +- If applicable, organize changes under "Added", "Changed", or "Fixed" sub-headings - Stick to one or two sentences. If more detail is needed for a particular change, consider adding it to the "Solution" section - - If you can't summarize the work your change may be unreasonably large / unrelated. Consider splitting your PR to make it easier to review and merge! + - If you can't summarize the work, your change may be unreasonably large / unrelated. Consider splitting your PR to make it easier to review and merge! ## \[Optional\] Migration Guide From fd16adb18de0e6a32bd22fda81c0eb2438e39e9a Mon Sep 17 00:00:00 2001 From: MrGVSV <49806985+MrGVSV@users.noreply.github.com> Date: Mon, 7 Mar 2022 16:03:24 -0800 Subject: [PATCH 5/7] Apply suggestions from code review Co-authored-by: Alice Cecile --- .github/pull_request_template.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index eda30abbd24cc..07233b1e754f4 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -9,7 +9,7 @@ ## \[ Optional \] Changelog -- What changed as a result of this PR? +- What changed as a result of this PR? If this was a trivial fix, or has no externally-visible impact, feel free to skip this section. - Stick to one or two sentences. If more detail is needed for a particular change, consider adding it to the "Solution" section - If you can't summarize the work your change may be unreasonably large / unrelated. Consider splitting your PR to make it easier to review and merge! From 38b95b45fe8bddab30437d54e9cd0cd7e24b2049 Mon Sep 17 00:00:00 2001 From: MrGVSV Date: Mon, 7 Mar 2022 16:24:15 -0800 Subject: [PATCH 6/7] Small fix --- .github/pull_request_template.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 82bd6e4b56e25..ea3830f0e4242 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -9,7 +9,7 @@ --- -## \[ Optional \] Changelog +## \[Optional\] Changelog - What changed as a result of this PR? If this was a trivial fix, or has no externally-visible impact, feel free to skip this section. - If applicable, organize changes under "Added", "Changed", or "Fixed" sub-headings From e8433f7818d72d3367e32c9ae7b08a40c1c69d33 Mon Sep 17 00:00:00 2001 From: MrGVSV <49806985+MrGVSV@users.noreply.github.com> Date: Mon, 7 Mar 2022 17:56:44 -0800 Subject: [PATCH 7/7] Apply suggestions from code review --- .github/pull_request_template.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index ea3830f0e4242..4b3241ec69db0 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -9,14 +9,18 @@ --- -## \[Optional\] Changelog +## Changelog -- What changed as a result of this PR? If this was a trivial fix, or has no externally-visible impact, feel free to skip this section. +> This section is optional. If this was a trivial fix, or has no externally-visible impact, feel free to skip this section. + +- What changed as a result of this PR? - If applicable, organize changes under "Added", "Changed", or "Fixed" sub-headings - Stick to one or two sentences. If more detail is needed for a particular change, consider adding it to the "Solution" section - If you can't summarize the work, your change may be unreasonably large / unrelated. Consider splitting your PR to make it easier to review and merge! -## \[Optional\] Migration Guide +## Migration Guide + +> This section is optional - If this PR is a breaking change (relative to the last release of Bevy), describe how a user might need to migrate their code to support these changes - Simply adding new functionality is not a breaking change.