First, ensure you have Node v10+ and the latest yarn installed on your machine.
As an external contributor, you will have to fork PeculiarVentures/asn1-schema to contribute code. Clone your fork onto your machine and then run the following commands to install dependencies:
git clone [email protected]:<username>/asn1-schema.git
cd asn1-schema
yarn bootstrap
yarn build
A typical contributor workflow looks like this:
- Create a new feature branch.
- Write some code.
- Ensure your code is tested.
- Add unit tests as necessary when fixing bugs or adding features; run them with
yarn test
in the relevantpackages/
directory.
- Add unit tests as necessary when fixing bugs or adding features; run them with
- Submit a Pull Request on GitHub and fill out the template.
- Team members will review your code and merge it after approvals.
- You may be asked to make modifications to code style or to fix bugs you may have not noticed.
- Please respond to comments in a timely fashion (even if to tell us you need more time).
- Cheers, you contributed!