From e554a96b599f03b07c5f7bc4feea753916c2cefa Mon Sep 17 00:00:00 2001 From: Alice Cecile Date: Fri, 20 May 2022 15:23:02 -0400 Subject: [PATCH 01/16] Improve PR template to encourage appropriate context in descriptions --- .github/pull_request_template.md | 25 ++++++++++++++++++------- 1 file changed, 18 insertions(+), 7 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 722f3aabe3aa6..a41a25557254b 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,13 +1,24 @@ # Objective -- Describe the objective or issue this PR addresses. -- If you're fixing a specific issue, say "Fixes #X". +Describe the objective or issue this PR addresses. -## Solution +If you're fixing a specific issue, say "Fixes #X" and the linked issue will automatically be closed when this PR is merged. +Under each bullet point, describe how this change addressed those objectives if it is not obvious. -- Describe the solution used to achieve the objective above. +**Changes that will affect external library users must update RELEASES.md before they will be merged.** ---- +## Context + +Discuss any context that may be needed for a user with only passing acquaintance with this library to understand the changes you've made. +This may include related issues, previous discussion, or relevant bits of how the library works). + +## Feedback wanted + +> This section is optional. If there are no particularly tricky or controversial changes, you can delete this section. + +Which parts of this PR were you unsure about? Which parts were particularly tricky? + +If you're stuck on part of the changes or want feedback early, open a draft PR and list the items that need to be completed here using a checklist. ## Changelog @@ -22,6 +33,6 @@ > This section is optional. If there are no breaking changes, you can delete this section. -- 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 +- If this PR is a breaking change (relative to the last release of this library), 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. +- Fixing behavior that was definitely a bug, rather than a questionable design choice, is not a breaking change. From d71e823f838e83b14bc390d237751b2e280aae8c Mon Sep 17 00:00:00 2001 From: Alice Cecile Date: Fri, 20 May 2022 15:52:44 -0400 Subject: [PATCH 02/16] Remove redundant Changelog section --- .github/pull_request_template.md | 9 --------- 1 file changed, 9 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index a41a25557254b..df371fce479de 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -20,15 +20,6 @@ Which parts of this PR were you unsure about? Which parts were particularly tric If you're stuck on part of the changes or want feedback early, open a draft PR and list the items that need to be completed here using a checklist. -## Changelog - -> This section is optional. If this was a trivial fix, or has no externally-visible impact, you can delete 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! - ## Migration Guide > This section is optional. If there are no breaking changes, you can delete this section. From 044e7f308211f3918246c8140725d04585d90114 Mon Sep 17 00:00:00 2001 From: Alice Cecile Date: Fri, 20 May 2022 15:54:31 -0400 Subject: [PATCH 03/16] Simplify language Co-authored-by: Gino Valente <49806985+MrGVSV@users.noreply.github.com> --- .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 df371fce479de..3b00276816b63 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -9,7 +9,7 @@ Under each bullet point, describe how this change addressed those objectives if ## Context -Discuss any context that may be needed for a user with only passing acquaintance with this library to understand the changes you've made. +Discuss any context that may be needed for a user who is not as familiar with this library to understand the changes you've made. This may include related issues, previous discussion, or relevant bits of how the library works). ## Feedback wanted From f271d94fc064f69071dd205654c75d74c850a8d3 Mon Sep 17 00:00:00 2001 From: Alice Cecile Date: Fri, 20 May 2022 15:54:40 -0400 Subject: [PATCH 04/16] Fix typo Co-authored-by: Gino Valente <49806985+MrGVSV@users.noreply.github.com> --- .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 3b00276816b63..44a2c1f11b39c 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -10,7 +10,7 @@ Under each bullet point, describe how this change addressed those objectives if ## Context Discuss any context that may be needed for a user who is not as familiar with this library to understand the changes you've made. -This may include related issues, previous discussion, or relevant bits of how the library works). +This may include related issues, previous discussion, or relevant bits of how the library works. ## Feedback wanted From 63451b74e324c19af3d44cc268b1cca953d429d1 Mon Sep 17 00:00:00 2001 From: Alice Cecile Date: Fri, 20 May 2022 15:56:28 -0400 Subject: [PATCH 05/16] Remove inaccurate line about RELEASES.md --- .github/pull_request_template.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index df371fce479de..bb9b59b008b28 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -5,8 +5,6 @@ Describe the objective or issue this PR addresses. If you're fixing a specific issue, say "Fixes #X" and the linked issue will automatically be closed when this PR is merged. Under each bullet point, describe how this change addressed those objectives if it is not obvious. -**Changes that will affect external library users must update RELEASES.md before they will be merged.** - ## Context Discuss any context that may be needed for a user with only passing acquaintance with this library to understand the changes you've made. From e8df4515a1fda3fbd9d00668d5734ec6784133a8 Mon Sep 17 00:00:00 2001 From: Alice Cecile Date: Fri, 20 May 2022 15:57:47 -0400 Subject: [PATCH 06/16] Remove line about draft PRs --- .github/pull_request_template.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index bb9b59b008b28..18e85b8478444 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -16,8 +16,6 @@ This may include related issues, previous discussion, or relevant bits of how th Which parts of this PR were you unsure about? Which parts were particularly tricky? -If you're stuck on part of the changes or want feedback early, open a draft PR and list the items that need to be completed here using a checklist. - ## Migration Guide > This section is optional. If there are no breaking changes, you can delete this section. From 52e6eef16807b49be598e65534dc041533e03e64 Mon Sep 17 00:00:00 2001 From: Alice Cecile Date: Fri, 20 May 2022 16:07:45 -0400 Subject: [PATCH 07/16] Add advice on explicitly listing changes made --- .github/pull_request_template.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 18e85b8478444..5d84df64edfab 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -5,6 +5,8 @@ Describe the objective or issue this PR addresses. If you're fixing a specific issue, say "Fixes #X" and the linked issue will automatically be closed when this PR is merged. Under each bullet point, describe how this change addressed those objectives if it is not obvious. +If this is a particularly complex PR, please add a clear list of the changes made. + ## Context Discuss any context that may be needed for a user with only passing acquaintance with this library to understand the changes you've made. From 5e87ad01c1fd9577f5fffe39503797f540fe9865 Mon Sep 17 00:00:00 2001 From: Alice Cecile Date: Fri, 20 May 2022 16:14:56 -0400 Subject: [PATCH 08/16] Edit for verbosity --- .github/pull_request_template.md | 16 +++++++--------- 1 file changed, 7 insertions(+), 9 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 5a1b1beed8056..72dd6fb9f435b 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,16 +1,15 @@ # Objective -Describe the objective or issue this PR addresses. - -If you're fixing a specific issue, say "Fixes #X" and the linked issue will automatically be closed when this PR is merged. -Under each bullet point, describe how this change addressed those objectives if it is not obvious. +Why are you making these changes? +Link any associated issues with "Fixes #X" so they can be automatically closed. +If it is not obvious, describe how the changes address those objectives. If this is a particularly complex PR, please add a clear list of the changes made. ## Context -Discuss any context that may be needed for a user who is not as familiar with this library to understand the changes you've made. -This may include related issues, previous discussion, or relevant bits of how the library works. +Discuss any context that may be needed for a new contributor to understand the changes you've made. +This may include related issues, previous discussion, or links to documentation. ## Feedback wanted @@ -22,6 +21,5 @@ Which parts of this PR were you unsure about? Which parts were particularly tric > This section is optional. If there are no breaking changes, you can delete this section. -- If this PR is a breaking change (relative to the last release of this library), 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. +If this PR is a breaking change, describe how a user might need to migrate their code to support these changes +Adding new functionality or fixing bugs is not a breaking change. From 8fc4cf968f4c2e80254f95eec94a4879127447a1 Mon Sep 17 00:00:00 2001 From: Alice Cecile Date: Fri, 20 May 2022 16:21:36 -0400 Subject: [PATCH 09/16] Condense Objective and Context --- .github/pull_request_template.md | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 72dd6fb9f435b..fd2b79bfa777f 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -2,13 +2,9 @@ Why are you making these changes? Link any associated issues with "Fixes #X" so they can be automatically closed. - -If it is not obvious, describe how the changes address those objectives. If this is a particularly complex PR, please add a clear list of the changes made. -## Context - -Discuss any context that may be needed for a new contributor to understand the changes you've made. +Discuss any background information that may be needed for a new contributor to understand the changes you've made. This may include related issues, previous discussion, or links to documentation. ## Feedback wanted From 447fd815dd6f13fc90e057faadd93ea1e5c5d508 Mon Sep 17 00:00:00 2001 From: Alice Cecile Date: Fri, 20 May 2022 17:43:47 -0400 Subject: [PATCH 10/16] Be more explicit about who needs more background MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: François --- .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 fd2b79bfa777f..45942f551a75c 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -4,7 +4,7 @@ Why are you making these changes? Link any associated issues with "Fixes #X" so they can be automatically closed. If this is a particularly complex PR, please add a clear list of the changes made. -Discuss any background information that may be needed for a new contributor to understand the changes you've made. +Discuss any background information that may be needed for someone unfamiliar with this area of the code to understand the changes you've made. This may include related issues, previous discussion, or links to documentation. ## Feedback wanted From 99ab63a784646ffc1bf34f37680d0974f1da1a1a Mon Sep 17 00:00:00 2001 From: Alice Cecile Date: Fri, 20 May 2022 18:12:06 -0400 Subject: [PATCH 11/16] Everyone needs context! --- .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 45942f551a75c..ec895185d5742 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -4,7 +4,7 @@ Why are you making these changes? Link any associated issues with "Fixes #X" so they can be automatically closed. If this is a particularly complex PR, please add a clear list of the changes made. -Discuss any background information that may be needed for someone unfamiliar with this area of the code to understand the changes you've made. +Discuss any background information that may be needed for other reviewers to understand the changes you've made. This may include related issues, previous discussion, or links to documentation. ## Feedback wanted From bdd4dcfd1d35656f7af05e03875a9aaf1e8911c6 Mon Sep 17 00:00:00 2001 From: Alice Cecile Date: Mon, 30 May 2022 14:18:57 -0400 Subject: [PATCH 12/16] Typo fix Co-authored-by: Thierry Berger --- .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 ec895185d5742..b554d4a2cbd41 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -17,5 +17,5 @@ Which parts of this PR were you unsure about? Which parts were particularly tric > This section is optional. If there are no breaking changes, you can delete this section. -If this PR is a breaking change, describe how a user might need to migrate their code to support these changes +If this PR is a breaking change, describe how a user might need to migrate their code to support these changes. Adding new functionality or fixing bugs is not a breaking change. From fb069a018bd86bea94aff16c4bec3ccbf90707d5 Mon Sep 17 00:00:00 2001 From: Alice Cecile Date: Mon, 30 May 2022 14:20:10 -0400 Subject: [PATCH 13/16] Remove extraneous words Co-authored-by: Thierry Berger --- .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 b554d4a2cbd41..909cdbe829dd0 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -2,7 +2,7 @@ Why are you making these changes? Link any associated issues with "Fixes #X" so they can be automatically closed. -If this is a particularly complex PR, please add a clear list of the changes made. +If this is a complex PR, please add a list of the changes made. Discuss any background information that may be needed for other reviewers to understand the changes you've made. This may include related issues, previous discussion, or links to documentation. From 2ce3a4655de1e90e1b244db1e0f0090e9adb7b43 Mon Sep 17 00:00:00 2001 From: Alice Cecile Date: Mon, 30 May 2022 14:20:40 -0400 Subject: [PATCH 14/16] Discuss background -> Provide background Co-authored-by: Thierry Berger --- .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 909cdbe829dd0..cff54770945af 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -4,7 +4,7 @@ Why are you making these changes? Link any associated issues with "Fixes #X" so they can be automatically closed. If this is a complex PR, please add a list of the changes made. -Discuss any background information that may be needed for other reviewers to understand the changes you've made. +Provide any background information that may be needed for other reviewers to understand the changes you've made. This may include related issues, previous discussion, or links to documentation. ## Feedback wanted From 2d2816a43fc2c143ce5eec5c440dbe01c5d6b6bc Mon Sep 17 00:00:00 2001 From: Alice Cecile Date: Fri, 3 Jun 2022 21:41:26 -0400 Subject: [PATCH 15/16] Mention CONTRIBUTING.md --- .github/pull_request_template.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index cff54770945af..6e7de06174688 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -4,6 +4,8 @@ Why are you making these changes? Link any associated issues with "Fixes #X" so they can be automatically closed. If this is a complex PR, please add a list of the changes made. +If this is you're new to Bevy, consider checking out our [Contributing Guide](https://github.com/bevyengine/bevy/blob/main/CONTRIBUTING.md) for information about our development practices :) + Provide any background information that may be needed for other reviewers to understand the changes you've made. This may include related issues, previous discussion, or links to documentation. From 55b1826dd1155f74a27649ce77e5e8e535fe7d70 Mon Sep 17 00:00:00 2001 From: Alice Cecile Date: Fri, 3 Jun 2022 21:41:49 -0400 Subject: [PATCH 16/16] Typo --- .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 6e7de06174688..2abcec931d115 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -4,7 +4,7 @@ Why are you making these changes? Link any associated issues with "Fixes #X" so they can be automatically closed. If this is a complex PR, please add a list of the changes made. -If this is you're new to Bevy, consider checking out our [Contributing Guide](https://github.com/bevyengine/bevy/blob/main/CONTRIBUTING.md) for information about our development practices :) +If you're new to Bevy, consider checking out our [Contributing Guide](https://github.com/bevyengine/bevy/blob/main/CONTRIBUTING.md) for information about our development practices :) Provide any background information that may be needed for other reviewers to understand the changes you've made. This may include related issues, previous discussion, or links to documentation.