From d0d0d3a23fa9b6459e9ac64cff9e9418756a2dcf Mon Sep 17 00:00:00 2001 From: Olivier Robert Date: Fri, 8 Jul 2022 11:33:49 +0700 Subject: [PATCH 1/3] Improve the description of each section --- .github/PULL_REQUEST_TEMPLATE.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 91206f9..bbcef11 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -2,12 +2,12 @@ https://github.com/nimblehq/git-template/issues/?? ## What happened 👀 -Describe the big picture of your changes here to communicate to the team why we should accept this pull request. +Provide a description of the **changes** this pull request brings to the codebase. Additionally, when the pull request is still being worked on, a checklist of the planned changes is welcome to track progress. -## Insight 📝 +## Insight 📝~ -Describe in detail how to test the changes, which solution you tried but did not go with, referenced documentation is welcome as well. +Describe in detail why this solution is the most appropriate, which solution you tried but did not go with, and how to test the changes. References to relevant documentation is welcome as well. ## Proof Of Work 📹 -Show us the implementation: screenshots, GIFs, etc. +Show us the implementation: screenshots, GIFs, etc. From 675c0abbdbce340acf47bfb86d8fd1392df25079 Mon Sep 17 00:00:00 2001 From: Olivier Robert Date: Fri, 8 Jul 2022 12:00:10 +0700 Subject: [PATCH 2/3] Fix grammatical mistake --- .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 bbcef11..d180e55 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -6,7 +6,7 @@ Provide a description of the **changes** this pull request brings to the codebas ## Insight 📝~ -Describe in detail why this solution is the most appropriate, which solution you tried but did not go with, and how to test the changes. References to relevant documentation is welcome as well. +Describe in detail why this solution is the most appropriate, which solution you tried but did not go with, and how to test the changes. References to relevant documentation are welcome as well. ## Proof Of Work 📹 From 316977113d2902de8fa1235f48d22037acaa1a0f Mon Sep 17 00:00:00 2001 From: Olivier Robert Date: Fri, 8 Jul 2022 12:00:35 +0700 Subject: [PATCH 3/3] Remove extra space --- .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 d180e55..84d970f 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -10,4 +10,4 @@ Describe in detail why this solution is the most appropriate, which solution you ## Proof Of Work 📹 -Show us the implementation: screenshots, GIFs, etc. +Show us the implementation: screenshots, GIFs, etc.