diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index d705a4791..b276131f7 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,25 +1,25 @@ ### JIRA link -_TD-###_ +[TD-####](https://hee-tis.atlassian.net/browse/TD-####) ### Description -_Describe what has changed and how that will affect the app. If relevant, add references to the resources you used. Use this as your opportunity to highlight anything odd and give people context around particular decisions._ +_Describe what has changed and how that will affect the app. If relevant, add links to any sources/documentation you used. Highlight anything unusual and give people context around particular decisions._ ### Screenshots -_Attach screenshots on mobile, tablet and desktop._ +_Paste screenshots for all views created or changed: mobile, tablet and desktop, wave analyser showing no errors._ ----- ### Developer checks (Leave tasks unticked if they haven't been appropriate for your ticket.) I have: -- [ ] Run the formatter and made sure there are no IDE errors -- [ ] Written appropriate unit tests for the changes, including: - - accessibility tests for new views - - tests for new controller methods - - tests for new or modified API endpoints -- [ ] Manually tested my work with and without JavaScript -- [ ] Tested any Views or partials created or changed with [Wave Chrome plugin](https://chrome.google.com/webstore/detail/wave-evaluation-tool/jbbplnpkjmmeebjpijfedlgcdilocofh/related) and addressed any valid accessibility issues -- [ ] Updated/added documentation in [Confluence](https://hee-tis.atlassian.net/wiki/spaces/TP/pages/3477930003/Learning+Hub) and/or [GitHub Readme](https://github.com/TechnologyEnhancedLearning/LearningHub.Nhs.UserApi/blob/master/README.md). List of documentation links added/changed: +- [ ] Run the IDE auto formatter on all files I’ve worked on and made sure there are no IDE errors relating to them +- [ ] Written or updated tests for the changes (accessibility ui tests for views, tests for controller, data services, services, view models created or modified) and made sure all tests are passing +- [ ] Manually tested my work with and without JavaScript (adding notes where functionality requires JavaScript) +- [ ] Tested any Views or partials created or changed with [Wave Chrome plugin](https://chrome.google.com/webstore/detail/wave-evaluation-tool/jbbplnpkjmmeebjpijfedlgcdilocofh/related). Addressed any valid accessibility issues and documented any invalid errors +- [ ] Updated my Jira ticket with testing notes, including information about other parts of the system that were touched as part of the MR and need to be tested to ensure nothing is broken +- [ ] Scanned over my pull request in GitHub and addressed any warnings from the GitHub Build and Test checks in the GitHub PR ‘Files Changed’ tab +Either: +- [ ] Documented my work in [Confluence](https://hee-tis.atlassian.net/wiki/spaces/TP/pages/3461087233/Development), updating any business rules applied or modified. Updated GitHub readme/documentation for the repository if appropriate. List of documentation links added/changed: - [doc_1_here](link_1_here) -- [ ] Updated my Jira ticket with information about other parts of the system that were touched as part of the MR and have to be sanity tested to ensure nothing is broken -- [ ] Scanned over my pull request in GitHub and addressed any warnings from the GitHub Build and Test checks. +Or: +- [ ] Confirmed that none of the work that I have undertaken requires any updates to documentation \ No newline at end of file