File tree Expand file tree Collapse file tree 2 files changed +19
-4
lines changed
Expand file tree Collapse file tree 2 files changed +19
-4
lines changed Original file line number Diff line number Diff line change @@ -4,9 +4,24 @@ We welcome all contributions!
44
55## Developing
66
7- First, run ` yarn ` to install all deps.
7+ ``` sh
8+ yarn # install deps
9+
10+ yarn build # this is required for tests to pass
11+
12+ yarn test
13+
14+ ```
15+
16+ Run ` yarn test:fix ` before pushing; it will run eslint, prettier in fix mode and run all tests.
17+
18+ ### Changesets
19+
20+ We use [ changesets] ( https://github.com/atlassian/changesets ) for changelog management. Changeset is a file specifying
21+ type of change (major, minor, patch) and summary of change from the ** users perspective** . Run ` yarn changeset add ` and
22+ follow the wizard.
823
9- Run ` yarn test:fix ` before pushing, it will run eslint, prettier in fix mode and run all tests .
24+ As a one-time contributor, you don't need to worry about this as a maintainer will usually write a changeset for you .
1025
1126### Local linking
1227
@@ -16,5 +31,5 @@ Run `yarn build` to build all packages or `yarn watch` to start watching. Then e
1631### Debugging 🐞
1732
1833``` sh
19- DEBUG=@dethcrypto/eth-sdk eth-sdk
34+ DEBUG=* eth-sdk
2035```
Original file line number Diff line number Diff line change @@ -290,7 +290,7 @@ it's better to use TypeChain directly (especially via HardHat integration).
290290
291291# Contributing
292292
293- Check out our [ contributing guidelines] ( ./CONTRIBUTING.md )
293+ Check out our [ contributing guidelines] ( ./CONTRIBUTING.md ) .
294294
295295# License
296296
You can’t perform that action at this time.
0 commit comments