Skip to content

Commit 1b3dcef

Browse files
authored
Merge pull request #7144 from NomicFoundation/contributing-update-v3
Contributing update v3
2 parents 5e7faf9 + feffc95 commit 1b3dcef

File tree

1 file changed

+23
-3
lines changed

1 file changed

+23
-3
lines changed

CONTRIBUTING.md

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,11 @@ To install the project's dependencies, run `pnpm i` in the root directory of the
2222

2323
## Building the projects
2424

25-
Plugins require hardhat to be built or tested. Our recommendation is to run `pnpm watch` from the root folder. This will keep everything compiled, and these problems will be avoided.
25+
Plugins require hardhat to be built or tested. Our recommendation is to run `pnpm build` from the root folder.
2626

2727
## Testing
2828

29-
All tests are written using [mocha](https://mochajs.org) and [chai](https://www.chaijs.com).
29+
All tests are written using [node test runner](https://nodejs.org/api/test.html).
3030

3131
### Per-package
3232

@@ -95,7 +95,7 @@ This is a list of the modules that always get loaded during startup:
9595

9696
## Developing locally
9797

98-
All these tips assume you are running `pnpm watch` from the root directory.
98+
The project can be built by `pnpm build` from the root directory.
9999

100100
### Linking
101101

@@ -148,3 +148,23 @@ We generally really appreciate external contributions, and strongly encourage me
148148
- It introduces inconsequential changes (e.g. rewording phrases)
149149
- The author of the PR does not respond in a timely manner
150150
- We suspect the Github account of the author was created for airdrop farming
151+
152+
## Contributing Checklist
153+
154+
Shortlist of steps that should be always considered when committing changes. All errors reported by any command must be resolved before moving ahead.
155+
156+
> All commands expect that they are executed from the root of the repository.
157+
158+
1) `pnpm build` - build the entire project
159+
2) `pnpm lint` - check formatting and code structure
160+
3) `pnpm lint:fix` - fix formatting issues
161+
4) `pnpm test` - run all tests
162+
163+
Commit changes and create a PR once all the commands above are successful. The CI pipeline would block the PR otherwise.
164+
165+
5) Create a branch for the change
166+
* there is a `Create a branch` option in the `Development` section in case the change is tracked by an issue
167+
6) Create a PR from the new branch to `main`
168+
* Add description that explains the change
169+
170+

0 commit comments

Comments
 (0)