From 69b1a60082904bb3b1802ec91a6fe8caa6c3eada Mon Sep 17 00:00:00 2001 From: ramsaptami <79509062+ramsaptami@users.noreply.github.com> Date: Fri, 5 May 2023 20:38:21 +0530 Subject: [PATCH] chore: cleaned up formatting for the template (#22670) ## Description Cleaned up template heading and section styles on PR template - Chore (housekeeping or task changes that don't impact user perception) --------- Co-authored-by: Hetu Nandu --- .github/pull_request_template.md | 81 +++++++++++++++++--------------- 1 file changed, 44 insertions(+), 37 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 2afc59a5d2..65f7017a91 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,52 +1,56 @@ > Pull Request Template > > Use this template to quickly create a well written pull request. Delete all quotes before creating the pull request. - +> ## Description - +> Add a TL;DR when description is extra long (helps content team) +> > Please include a summary of the changes and which issue has been fixed. Please also include relevant motivation > and context. List any dependencies that are required for this change +> > Links to Notion, Figma or any other documents that might be relevant to the PR - -> Add a TL;DR when description is extra long (helps content team) - -Fixes # (issue) +> +> +#### PR fixes following issue(s) +Fixes # (issue number) > if no issue exists, please create an issue and ask the maintainers about this first - - -Media +> +> +#### Media > A video or a GIF is preferred. when using Loom, don’t embed because it looks like it’s a GIF. instead, just link to the video - - -## Type of change - +> +> +#### Type of change > Please delete options that are not relevant. - - Bug fix (non-breaking change which fixes an issue) - New feature (non-breaking change which adds functionality) - Breaking change (fix or feature that would cause existing functionality to not work as expected) - Chore (housekeeping or task changes that don't impact user perception) - This change requires a documentation update - - -## How Has This Been Tested? -> Please describe the tests that you ran to verify your changes. Provide instructions, so we can reproduce. -> Please also list any relevant details for your test configuration. -> Delete anything that is not important - -- Manual -- Jest -- Cypress - -### Test Plan +> +> +> +## Testing +> +#### How Has This Been Tested? +> Please describe the tests that you ran to verify your changes. Also list any relevant details for your test configuration. +> Delete anything that is not relevant +- [ ] Manual +- [ ] Jest +- [ ] Cypress +> +> +#### Test Plan > Add Testsmith test cases links that relate to this PR - -### Issues raised during DP testing +> +> +#### Issues raised during DP testing > Link issues raised during DP testing for better visiblity and tracking (copy link from comments dropped on this PR) - - +> +> +> ## Checklist: -### Dev activity +#### Dev activity - [ ] My code follows the style guidelines of this project - [ ] I have performed a self-review of my own code - [ ] I have commented my code, particularly in hard-to-understand areas @@ -57,9 +61,12 @@ Media - [ ] PR is being merged under a feature flag -### QA activity: -- [ ] Test plan has been approved by relevant developers -- [ ] Test plan has been peer reviewed by QA -- [ ] Cypress test cases have been added and approved by either SDET or manual QA -- [ ] Organized project review call with relevant stakeholders after Round 1/2 of QA -- [ ] Added Test Plan Approved label after reveiwing all Cypress test +#### QA activity: +- [ ] [Speedbreak features](https://github.com/appsmithorg/TestSmith/wiki/Test-plan-implementation#speedbreaker-features-to-consider-for-every-change) have been covered +- [ ] Test plan covers all impacted features and [areas of interest](https://github.com/appsmithorg/TestSmith/wiki/Guidelines-for-test-plans/_edit#areas-of-interest) +- [ ] Test plan has been peer reviewed by project stakeholders and other QA members +- [ ] Manually tested functionality on DP +- [ ] We had an implementation alignment call with stakeholders post QA Round 2 +- [ ] Cypress test cases have been added and approved by SDET/manual QA +- [ ] Added `Test Plan Approved` label after Cypress tests were reviewed +- [ ] Added `Test Plan Approved` label after JUnit tests were reviewed