From ae108d17fd4e2f89a459d6b915fb2ec545ef4371 Mon Sep 17 00:00:00 2001 From: Kat Leight Date: Thu, 9 Mar 2023 11:21:55 -0700 Subject: [PATCH] add reminders to complete PR checklist --- .../[...1]overview/[...2]contribution-guide.md | 14 +++++++++----- pull_request_template.md | 6 ++++-- 2 files changed, 13 insertions(+), 7 deletions(-) diff --git a/docs/src/routes/docs/[...1]overview/[...2]contribution-guide.md b/docs/src/routes/docs/[...1]overview/[...2]contribution-guide.md index c8f892d26..6885e11c9 100644 --- a/docs/src/routes/docs/[...1]overview/[...2]contribution-guide.md +++ b/docs/src/routes/docs/[...1]overview/[...2]contribution-guide.md @@ -23,7 +23,9 @@ Once an issue is created, a Web3 Onboard maintainer will review and respond typi 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. -Once a PR is created, a Web3 Onboard maintainer will acknowledge it and add to sprint planning for review as soon as possible. +Once a PR is created, a Web3 Onboard maintainer will acknowledge it and add to sprint planning for review as soon as possible. + +**Important Note: The PR template checklist must be complete before review can take place.** ### Package Versioning πŸ“¦ @@ -39,9 +41,9 @@ Example 2 : Bug fix within the `core` package - ## [How can I add a new wallet? πŸ’³](#new-wallet) -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. +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. -Please also add documentation updates by creating a separate [docs pull request](#documentation-contributions-πŸ“„). +Please also include updates to documentation in your PR. Refer to the [docs contributions section](#documentation-contributions-πŸ“„) and the PR template docs checklist. ### Adding Injected Wallets 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 If you contribute to the code, you should definitely document appropriately. -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. +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. + +**Important note: The PR template docs checklist must be complete before review can take place.** -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). +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). [See here for an example of a docs pull request.](https://github.com/blocknative/web3-onboard/pull/1544/files) diff --git a/pull_request_template.md b/pull_request_template.md index 0eb34e73e..d677ad874 100644 --- a/pull_request_template.md +++ b/pull_request_template.md @@ -1,17 +1,19 @@ ### Description + +#### **_PLEASE NOTE- Checklist must be complete prior to review._** ### Checklist - [ ] 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 - [ ] Check the box that allows repo maintainers to update this PR - [ ] Test locally to make sure this feature/fix works -- [ ] Run `yarn file-check`, `yarn type-check` & `yarn build` to confirm there are not any associated errors +- [ ] Run `yarn check-all` to confirm there are not any associated errors - [ ] Confirm this PR passes Circle CI checks - [ ] Add or update relevant information in the documentation ### Docs Checklist - [ ] Include a screenshot of any changes ([see docs README on running locally](https://github.com/blocknative/web3-onboard/blob/develop/docs/README.md)) -- [ ] Add/update the appropriate package README +- [ ] Add/update the appropriate package README (if applicable) - [ ] 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) - [ ] Add/update the related package in the `docs/package.json` file (if applicable)