CONTRIBUTING.md

How to become a contributor and submit your own code

Note: Additional rules are welcome and can be added in src/rules.ts.

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

Running the tests

1. Prepare your environment for Node.js setup.

2. Install dependencies:

   npm install
   

3. Run the tests:

   # Run unit tests.
   npm test