Skip to content

Commit 689426c

Browse files
committed
docs: add instructions for contributing code
1 parent 2c61512 commit 689426c

File tree

1 file changed

+19
-2
lines changed

1 file changed

+19
-2
lines changed

README.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -616,5 +616,22 @@ and destruct.js is available under `benchmark/`.
616616

617617
Please report issues to the
618618
[issue tracker](https://github.com/keichi/binary-parser/issues) if you have
619-
any difficulties using this module, found a bug, or request a new feature.
620-
Pull requests are welcomed.
619+
any difficulties using this module, found a bug, or would like to request a
620+
new feature. Pull requests are welcome.
621+
622+
To contribute code, first clone this repo, then install the dependencies:
623+
624+
```bash
625+
git clone https://github.com/keichi/binary-parser.git
626+
cd binary-parser
627+
npm install
628+
```
629+
630+
If you added a feature or fixed a bug, update the test suite under `test/` and
631+
then run it like this:
632+
633+
```bash
634+
npm run test
635+
```
636+
637+
Make sure all the tests pass before submitting a pull request.

0 commit comments

Comments
 (0)