You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+23-3Lines changed: 23 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,11 +22,11 @@ To install the project's dependencies, run `pnpm i` in the root directory of the
22
22
23
23
## Building the projects
24
24
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.
26
26
27
27
## Testing
28
28
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).
30
30
31
31
### Per-package
32
32
@@ -95,7 +95,7 @@ This is a list of the modules that always get loaded during startup:
95
95
96
96
## Developing locally
97
97
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.
99
99
100
100
### Linking
101
101
@@ -148,3 +148,23 @@ We generally really appreciate external contributions, and strongly encourage me
148
148
- It introduces inconsequential changes (e.g. rewording phrases)
149
149
- The author of the PR does not respond in a timely manner
150
150
- 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
0 commit comments