Skip to content

Commit ae108d1

Browse files
committed
add reminders to complete PR checklist
1 parent dd7a9ab commit ae108d1

File tree

2 files changed

+13
-7
lines changed

2 files changed

+13
-7
lines changed

docs/src/routes/docs/[...1]overview/[...2]contribution-guide.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,9 @@ Once an issue is created, a Web3 Onboard maintainer will review and respond typi
2323

2424
To create a new feature or change in Web3 Onboard, fork the repo and make a pull request on the [develop branch](https://github.com/blocknative/web3-onboard/tree/develop) to have your changes merged in and released as part of the official packages.
2525

26-
Once a PR is created, a Web3 Onboard maintainer will acknowledge it and add to sprint planning for review as soon as possible.
26+
Once a PR is created, a Web3 Onboard maintainer will acknowledge it and add to sprint planning for review as soon as possible.
27+
28+
**Important Note: The PR template checklist must be complete before review can take place.**
2729

2830
### Package Versioning 📦
2931

@@ -39,9 +41,9 @@ Example 2 : Bug fix within the `core` package -
3941

4042
## [How can I add a new wallet? 💳](#new-wallet)
4143

42-
To add a new wallet to the official Web3 Onboard packages and repo, create a [pull request](#pull-requests-🗂️). Web3 Onboard does not require a wallet to be a part of the main code, so a separate wallet module can be created without any changes to the Web3Onboard codebase. Your pull request must include a README for the package.
44+
To add a new wallet to the official Web3 Onboard packages and repo, create a [pull request](#pull-requests-🗂️). Web3 Onboard does not require a wallet to be a part of the main code, so a separate wallet module can be created without any changes to the Web3Onboard codebase. Your PR must include a detailed README for the package, keeping in mind that this README is the the first point of contact for dapp devs looking to implement your wallet.
4345

44-
Please also add documentation updates by creating a separate [docs pull request](#documentation-contributions-📄).
46+
Please also include updates to documentation in your PR. Refer to the [docs contributions section](#documentation-contributions-📄) and the PR template docs checklist.
4547

4648
### Adding Injected Wallets
4749
If the wallet you are adding is an “injected” wallet (browser extension, mobile dapp browser wallet), add a wallet to the injected wallets module. [See here for an example of an injected wallets pull request.](https://github.com/blocknative/web3-onboard/pull/1177/files) You should also add the wallet to the [natively supported injected wallets list](http://localhost:3000/docs/wallets/injected#injected-wallets-supported-natively).
@@ -57,9 +59,11 @@ If you cannot write the code yourself to add a new wallet, create a new feature
5759

5860
If you contribute to the code, you should definitely document appropriately.
5961

60-
In order to contribute to the docs, create a PR on the [develop branch](https://github.com/blocknative/web3-onboard/tree/develop). The PR description should include a screenshot of any changes.
62+
In order to contribute to the docs, create a PR on the [develop branch](https://github.com/blocknative/web3-onboard/tree/develop). The PR description should include a screenshot of any changes.
63+
64+
**Important note: The PR template docs checklist must be complete before review can take place.**
6165

62-
Docs PRs for adding/updating a wallet should include a README (new or updated) for the package (located in `docs/src/routes/docs/[...4]wallets`), and adding/updating the module in [docs demo](https://github.com/blocknative/web3-onboard/blob/develop/docs/src/lib/services/onboard.js) and docs package (`docs/package.json`). New injected wallets should also add the wallet to the [natively supported injected wallets list](https://github.com/blocknative/web3-onboard/blob/develop/docs/src/routes/docs/%5B...4%5Dwallets/injected.md).
66+
PRs for adding/updating a wallet should include a README (new or updated) for the package (located in `docs/src/routes/docs/[...4]wallets`), and adding/updating the module in [docs demo](https://github.com/blocknative/web3-onboard/blob/develop/docs/src/lib/services/onboard.js) and docs package (`docs/package.json`). New injected wallets should also add the wallet to the [natively supported injected wallets list](https://github.com/blocknative/web3-onboard/blob/develop/docs/src/routes/docs/%5B...4%5Dwallets/injected.md).
6367

6468
[See here for an example of a docs pull request.](https://github.com/blocknative/web3-onboard/pull/1544/files)
6569

pull_request_template.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,19 @@
11
### Description
22
<!-- Add a description of the fix or feature here -->
33

4+
5+
#### **_PLEASE NOTE- Checklist must be complete prior to review._**
46
### Checklist
57
- [ ] Increment the version field in `package.json` of the package you have made changes in following [semantic versioning](https://semver.org/) and using alpha release tagging
68
- [ ] Check the box that allows repo maintainers to update this PR
79
- [ ] Test locally to make sure this feature/fix works
8-
- [ ] Run `yarn file-check`, `yarn type-check` & `yarn build` to confirm there are not any associated errors
10+
- [ ] Run `yarn check-all` to confirm there are not any associated errors
911
- [ ] Confirm this PR passes Circle CI checks
1012
- [ ] Add or update relevant information in the documentation
1113

1214
### Docs Checklist
1315
- [ ] Include a screenshot of any changes ([see docs README on running locally](https://github.com/blocknative/web3-onboard/blob/develop/docs/README.md))
14-
- [ ] Add/update the appropriate package README
16+
- [ ] Add/update the appropriate package README (if applicable)
1517
- [ ] Add/update the related module in the [docs demo](https://github.com/blocknative/web3-onboard/blob/develop/docs/src/lib/services/onboard.js) (if applicable)
1618
- [ ] Add/update the related package in the `docs/package.json` file (if applicable)
1719

0 commit comments

Comments
 (0)