chore: update pr template (#859)

* chore: update pr template

* chore: update pull request template after comments

* chore: update PULL_REQUEST_TEMPLATE.md

* chore: update PULL_REQUEST_TEMPLATE.md

---------

Co-authored-by: Den <36603049+dhriaznov@users.noreply.github.com>
This commit is contained in:
Tim Man
2025-01-31 18:47:13 +08:00
committed by GitHub
parent 5d3c671e1e
commit 25bead5c96

View File

@@ -1,63 +1,49 @@
# 🔘 PR Type
What kind of change does this PR introduce?
<!-- Please check the one that applies to this PR using "x". -->
- [ ] Bugfix
- [ ] Enhancement
- [ ] Code style update (formatting, local variables)
- [ ] Refactoring (no functional changes, no API changes)
- [ ] Build related changes
- [ ] CI related changes
- [ ] Documentation content changes
- [ ] Other... Please describe:
# 📜 Background
Provide a brief explanation of why this pull request is needed. Include the problem you are solving or the functionality you are adding. Reference any related issues.
Issue Link: #[issue_number]
Context Link (if applicable):
# 🔄 Changes
Enumerate the changes made in this pull request, detailing what has been modified, added, or removed. Include technical details and implications if necessary.
Impact:
- Explain the broader impact of these changes.
- How it improves performance, fixes bugs, adds functionality, etc.
# 🧪 E2E Test Result
Include a screenshot of the e2e test result.
`Run E2E Tests`
Our End-to-end (E2E) test suite is build with Playwright. To run the whole E2E test suite, run:
`npm run e2etest`
If you only want to run the smoke test suite, run
`npm run e2etest:smoketest`
If you want to run the e2e test in UI Mode:
`npm run e2etest:ui`
To generate test report, run:
`npm run e2etest:report`
# Summary
Link to Linear issue (if not linked by bot):
- [ ] PR Title was updated to match: `<branch_type>: <descriptive, short message of what work was done> [<parent issue ID1>][<parent issue ID2>]`
[See Branch types here](https://www.notion.so/xverseapp/Xverse-Contributing-1215520b9dee80cb9497f6866a99e2f4?pvs=4#1365520b9dee80f78f9ecd9f0bb23a8f)
# 🖼 Screenshot / 📹 Video
Include screenshots or a video demonstrating the changes. This is especially helpful for UI changes.
| Before | After |
| :---: | :---: |
|<img width="50%" alt="" src="" />|<img width="50%" alt="" src="" />|
# ✅ Review checklist
# 🔄 Changes
- What has been added, modified removed?
- Where was the fix?
- Include technical details and implications if necessary.
- What xverse-core changes were included?
Please ensure the following are true before merging:
Impact:
- Explain the broader impact of these changes.
- Which areas of the application have been touched?
- What should the tester be aware of when testing?
- What can help the reviewer to be aware of when reading the code?
- What are the security implications?
- [ ] Code Style is consistent with the project guidelines.
- [ ] Code is readable and well-commented.
- [ ] No unnecessary or debugging code has been added.
- [ ] Security considerations have been taken into account.
- [ ] The change has been manually tested and works as expected.
- [ ] Breaking changes and their impacts have been considered and documented.
- [ ] Code does not introduce new technical debt or issues.
# 🔍 Testing Steps
1. How to set up testing of the changes
2. What steps to test
3. What is expected
- [ ] Does this need QA? (If so, add the label `Ready for test`) [See considerations here](https://www.notion.so/xverseapp/Xverse-Contributing-1215520b9dee80cb9497f6866a99e2f4?pvs=4#13e5520b9dee80938816fa66214541db)
# ✅ Author checklist (can be draft if not all ready)
Please ensure the following are true before submitting for review:
- [ ] The PR template has been filled.
- [ ] E2E tests or unit tests have been added/updated.
- [ ] The changes have been self-reviewed, and has been tidied up for an easy peer review.
- [ ] No debugging code
- [ ] No out of scope changes
- [ ] Should the PR be split up for easier review?
- [ ] The change has been manually tested and works as expected.
- [ ] The PR has been labeled/flagged for QA if necessary.
# ✅ Reviewer checklist
- [ ] The changes follow the intended scope.
- [ ] Code is clean and readable. No anti-patterns, no code smells.
- [ ] Code structure maintains separation of concerns.
- [ ] Check that code does not belong in xverse-core, or also on mobile.
- [ ] E2E tests or unit tests have been added/updated.
- [ ] (If no QA) The PR has been manually tested and works as expected.