Skip to content

Commit f8d4314

Browse files
committed
feat(pr readme): we're due a version bump i feel
1 parent 4c02e5a commit f8d4314

File tree

1 file changed

+52
-33
lines changed

1 file changed

+52
-33
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 52 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,48 +1,67 @@
11
# PR Template
22

3-
## TODO:
4-
Test it here too
5-
https://technologyenhancedlearning.github.io/GitPageBlazorWASM-TestGHPage/
6-
check version matches branch name and pullrequest release
7-
- maybe a rule that any introduced css for example if bringing in an enum. needs to be refactored to nhse-tel? so tel-nhse is source of truth on all things css
8-
9-
10-
## TODO: About
11-
- SO FAR no js controllers are not going to be covered in testing in the package it will be done by how used in LH
12-
But in future we could simulate them with just an api with stock response or find a programatic way, or build a hosted environment.
13-
The gh-page are pure wasm so not supported for nojs
14-
15-
- brave check no js (Locally not on wasm static test page)
16-
17-
## TODO: This is just replicating LH for now ... ideas
18-
- Link to replicated component
19-
- Link design confluence if coming from design
20-
- Tick box for JS
21-
- If testers find an issue create an automated test of what they did, even potentially with playright record test functionality
22-
- something about is there a linked lh branch using the change
23-
24-
### JIRA link
3+
### JIRA/RoadMap
4+
_Provide your ticket number
255
[TD-####](https://hee-tis.atlassian.net/browse/TD-####)
6+
[Git Ticket Board](https://github.com/orgs/TechnologyEnhancedLearning/projects/9)[Ticket Board](https://github.com/orgs/TechnologyEnhancedLearning/projects/9)
7+
[Git Ticket](https://github.com/TechnologyEnhancedLearning/TELBlazor/issues/42)
268

279
### Description
2810
_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._
2911

12+
### Resulting Dev package
13+
_Your dev generated package name and reference
14+
[TELBlazor published packages](https://github.com/TechnologyEnhancedLearning/TELBlazor/pkgs/nuget/TELBlazor.Components)
15+
Dev packages are follow by branch name -branch-name and are generated
16+
Will this code change result in a production package version increase
17+
3018
### Screenshots
3119
_Paste screenshots for all views created or changed: mobile, tablet and desktop, wave analyser showing no errors._
3220

21+
### Linked package consumer tasks
22+
[TD-####](https://hee-tis.atlassian.net/browse/TD-####)
23+
[ ] - consumers also need to update nhsuk css dependency to : __put_required_nhsuk_semantic_version_here__
24+
25+
### Logging
26+
_Provide description of any component scoped logging or specific level logging to check
27+
3328
-----
3429
### Developer checks
3530
(Leave tasks unticked if they haven't been appropriate for your ticket.)
3631

3732
I have:
38-
- [ ] Run the IDE auto formatter on all files I’ve worked on and made sure there are no IDE errors relating to them
39-
- [ ] 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
40-
- [ ] Manually tested my work with and without JavaScript (adding notes where functionality requires JavaScript)
41-
- [ ] 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
42-
- [ ] 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
43-
- [ ] 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
44-
Either:
45-
- [ ] 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:
46-
- [doc_1_here](link_1_here)
47-
Or:
48-
- [ ] Confirmed that none of the work that I have undertaken requires any updates to documentation
33+
- [ ] Provided showcase example of component if applicable
34+
- [ ] Added appropriate logging and scopped logging reporting in appsettings for component if applicable
35+
- [ ] Updated readme documentation
36+
- [ ] Updated showcase documentation for component
37+
- [ ] I have locally run tests against a local package (not just using project reference)
38+
- [ ] Used a browser set to No Js before using it to locally run and test changes (recommend brave as second browser)
39+
- [ ] Written Unit tests with accesibility syntax
40+
- [ ] Written E2E tests with accesibility syntax and accessibility test
41+
- [ ] Tested components 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
42+
- [ ] [Check code coverage](https://technologyenhancedlearning.github.io/TELBlazor-CodeReport/) or locally with local report generation
43+
- [ ] Updated my Jira ticket with testing notes, including information about other parts of the system that were touched as part of the PR and need to be tested to ensure nothing is broken
44+
- [ ] Tested in [Dev Showcase](https://technologyenhancedlearning.github.io/TELBlazor-DevShowCase/) (including logging by using log level switcher)
45+
- [ ] Scanned over my pull request and commented with any useful explanations/questions to reviewers
46+
- [ ] Scanned over cicd warnings
47+
48+
---
49+
### Peer Reviewers and Assignee checks before Approval
50+
- [ ] Feedback has been provided
51+
- [ ] Project has been run locally (you can provide pr feedback via vs if desired)
52+
- [ ] Locally checked in browser set to No Js from before load (recommend Brave with no js settings)
53+
- [ ] [Dev Showcase](https://technologyenhancedlearning.github.io/TELBlazor-DevShowCase/) was checked and it was checked the package number matched the PR
54+
- [ ] In Dev Showcase checked against different logging levels if applicable (use log level switcher to change level)
55+
- [ ] All conversations have been responded to (emoji will do) and marked resolved
56+
- [ ] Out of scope code observations have been recorded to inform future tasks
57+
- [ ] Common questions / Architectural explanations decisions from PR documented
58+
- [ ] [Check code coverage](https://technologyenhancedlearning.github.io/TELBlazor-CodeReport/)
59+
- [ ] Should E2E or Unit test have been added
60+
- [ ] If the published dev package is linked and used in tandom with a package consumer task is it working locally (Not a hard requirement but useful in case changes required)
61+
- [ ] Checked component readme in Showcase
62+
63+
---
64+
### Post PR Intentions and Actions
65+
- [ ] On merge will someone check [Prod Showcase](https://technologyenhancedlearning.github.io/TELBlazor/)
66+
- [ ] Tick yes if consuming projects need a version bump and/or code changes to take advantage of new components etc
67+
- [ ] If there is a linked consuming project task has the task assignee, or task been updated to know the package is available as a dev/prod version and been provided the version number.

0 commit comments

Comments
 (0)