Skip to content

Latest commit

 

History

History
31 lines (20 loc) · 1.02 KB

CONTRIBUTING.md

File metadata and controls

31 lines (20 loc) · 1.02 KB
Raw

Contributing 💻

All contributions are welcome and greatly appreciated!

Steps to Contribute 💡

Check the .node-version file in the root of this repo so see what version of Node.js is required for local development - note, this can be different from the version of Node.js which runs the Action on GitHub runners

  1. Fork this repository
  2. Commit your changes
  3. Test your changes (learn how to test below)
  4. Open a pull request back to this repository

    Make sure to run npm run bundle as your final commit!

  5. Notify the maintainers of this repository for peer review and approval
  6. Merge!

The maintainers of this repository will create a new release with your changes so that everyone can use the new release and enjoy the awesome features of the auditor!

Testing 🧪

This project requires 100% test coverage

Running the test suite (suggested)

Simply run the following command to execute the entire test suite:

npm run test

Note: this requires that you have already run npm install