From cf9391ee421dfdbb90402d10e4ec2193547258d6 Mon Sep 17 00:00:00 2001 From: Ricardo Kreyhsig <2385700+rickreyhsig@users.noreply.github.com> Date: Wed, 24 Apr 2024 18:00:33 -0400 Subject: [PATCH 1/4] Create pull_request_template.md New pull request template suggestion --- docs/pull_request_template.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 docs/pull_request_template.md diff --git a/docs/pull_request_template.md b/docs/pull_request_template.md new file mode 100644 index 0000000000..793f12cb39 --- /dev/null +++ b/docs/pull_request_template.md @@ -0,0 +1,17 @@ +- [ ] Link to pivotal/JIRA issue +- [ ] What was done? + - Explain the implementation goals being solved or the feature with the reviewer in mind + - Mention any relevant issues or technical gotchas + - Alternatives considered +- [ ] How to test? + - Describe the testing approach taken to verify the changes, including: + - Unit/integration/manual tests + - Test data used + - Specify any relevant testing environments used (e.g., development, staging, demo, Heroku). + - Risk Assessment + - Risks or side effects associated with the changes and how they were mitigated. + - Highlight areas that may need extra attention during code review or testing. + - Paste SQL queries or output where relevant + - [ ] Screenshots (for visual change) + - Before | After + From 20c05d6d50a0a3f3b24b753deef6c9fa1e506695 Mon Sep 17 00:00:00 2001 From: Ricardo Kreyhsig <2385700+rickreyhsig@users.noreply.github.com> Date: Thu, 25 Apr 2024 14:22:10 -0400 Subject: [PATCH 2/4] Update docs/pull_request_template.md --- docs/pull_request_template.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/pull_request_template.md b/docs/pull_request_template.md index 793f12cb39..cd0966bc93 100644 --- a/docs/pull_request_template.md +++ b/docs/pull_request_template.md @@ -1,7 +1,7 @@ - [ ] Link to pivotal/JIRA issue - [ ] What was done? - Explain the implementation goals being solved or the feature with the reviewer in mind - - Mention any relevant issues or technical gotchas + - Mention any relevant issues or insights to be shared with the reviewer. - Alternatives considered - [ ] How to test? - Describe the testing approach taken to verify the changes, including: From 870ada8150a76967a6ce50e34facdd5143f90b37 Mon Sep 17 00:00:00 2001 From: Ricardo Kreyhsig <2385700+rickreyhsig@users.noreply.github.com> Date: Thu, 25 Apr 2024 19:51:40 -0400 Subject: [PATCH 3/4] Update docs/pull_request_template.md --- docs/pull_request_template.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/pull_request_template.md b/docs/pull_request_template.md index cd0966bc93..691323c468 100644 --- a/docs/pull_request_template.md +++ b/docs/pull_request_template.md @@ -1,4 +1,4 @@ -- [ ] Link to pivotal/JIRA issue +## Link to pivotal/JIRA issue - [ ] What was done? - Explain the implementation goals being solved or the feature with the reviewer in mind - Mention any relevant issues or insights to be shared with the reviewer. From dfe10d7758bcf569b5ff7df04852fe1b276e4ac5 Mon Sep 17 00:00:00 2001 From: Ricardo Kreyhsig <2385700+rickreyhsig@users.noreply.github.com> Date: Thu, 25 Apr 2024 19:53:39 -0400 Subject: [PATCH 4/4] Update pull_request_template.md --- docs/pull_request_template.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/docs/pull_request_template.md b/docs/pull_request_template.md index 691323c468..08092d5d06 100644 --- a/docs/pull_request_template.md +++ b/docs/pull_request_template.md @@ -1,9 +1,10 @@ ## Link to pivotal/JIRA issue -- [ ] What was done? + - +## What was done? - Explain the implementation goals being solved or the feature with the reviewer in mind - Mention any relevant issues or insights to be shared with the reviewer. - Alternatives considered -- [ ] How to test? +## How to test? - Describe the testing approach taken to verify the changes, including: - Unit/integration/manual tests - Test data used @@ -12,6 +13,6 @@ - Risks or side effects associated with the changes and how they were mitigated. - Highlight areas that may need extra attention during code review or testing. - Paste SQL queries or output where relevant - - [ ] Screenshots (for visual change) - - Before | After +## Screenshots (for visual change) + - Before | After