How to become a contributor and submit your own code

June 17, 2021 ยท View on GitHub

  1. Submit an issue describing your proposed change to the repo in question.
  2. The repo owner will respond to your issue promptly.
  3. Fork the desired repo, develop and test your code changes.
  4. Ensure that your code adheres to the existing style in the code to which you are contributing.
  5. Ensure that your code has an appropriate set of tests which all pass.
  6. Title your pull request following Conventional Commits styling.
  7. Submit a pull request.

Running the tests

  1. Install dependencies:

    npm i

  2. Run lint

    npm run lint
npm run format  # will fix some issues

  3. Run the tests:

    # Run unit tests.
npm test