CONTRIBUTING.md

How to become a contributor and submit your own code

Table of contents

• Contributing a patch
• Running the tests
• Releasing the library

Contributing a Patch

1. Submit an issue describing your proposed change to the repo in question.
2. The repo owner will respond to your issue promptly.
3. If your proposed change is accepted, and you haven't already done so, sign a Contributor License Agreement (see details above).
4. Fork the desired repo, develop and test your code changes.
5. Ensure that your code adheres to the existing style in the code to which you are contributing.
6. Ensure that your code has an appropriate set of tests which all pass.
7. Submit a pull request.

Running the tests

1. Prepare your environment for Node.js setup.

2. Install dependencies:

   yarn
   

3. Run the tests:

   npm test
   

4. Lint (and maybe fix) any changes:

   npm run fix