kylefang/xverse-web-extension
1
0
Fork 0
mirror of https://github.com/zhigang1992/xverse-web-extension.git synced 2026-01-12 09:43:44 +08:00
Code Issues Packages Projects Releases Wiki Activity

Add the E2E test result section to the PR template and updated the readme (#544)

Browse Source 
* Add the E2E test result section to the PR template

* updated the pr description for running e2e tests

* moved the E2E section from readme to PR description

* updated the node version in the readme to 18

---------

Co-authored-by: DuskaT021 <aleksa2601@gmail.com>
This commit is contained in:
Den
2024-09-03 15:14:18 +02:00
committed by GitHub
parent 96a00a88d9
commit e6c82b6c13
2 changed files with 24 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
.github/PULL_REQUEST_TEMPLATE.md vendored
View File

@@ -1,4 +1,5 @@
# 🔘 PR Type
What kind of change does this PR introduce?
<!-- Please check the one that applies to this PR using "x". -->
@@ -13,22 +14,44 @@ What kind of change does this PR introduce?
- [ ] 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`
# 🖼 Screenshot / 📹 Video
Include screenshots or a video demonstrating the changes. This is especially helpful for UI changes.
# ✅ Review checklist
Please ensure the following are true before merging:
- [ ] Code Style is consistent with the project guidelines.

29
README.md
View File

@@ -4,7 +4,7 @@
### Procedures
1. Check if your [Node.js](https://nodejs.org/) version is >= **14**.
1. Check if your [Node.js](https://nodejs.org/) version is >= **18**.
2. Clone this repository.
3. Make sure you're logged in to the @secretkeylabs scope on the GitHub NPM package registry. See the [Guide](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-npm-registry#authenticating-with-a-personal-access-token)
1. Create a GitHub personal access token (classic)
@@ -32,30 +32,3 @@ make or pull your local changes to xverse-core, then:
cd ../xverse-core && npm i && npm run build:esm && \
cd $OLDPWD && npm i --legacy-peer-deps @secretkeylabs/xverse-core@../xverse-core && npm start
```
### 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
```