Skip to content

Latest commit

 

History

History
20 lines (13 loc) · 1.02 KB

CONTRIBUTING.md

File metadata and controls

20 lines (13 loc) · 1.02 KB

Contributing

Thanks for considering contributing to the project - as a one man project all help is appreciated.

Bug reports

Bug reports should conform to the GitHub issue templates setup in this repository. Please fill all sections for your report - this will help for your issue to be resolved as soon as possible.

Pull requests

For large changes, please open an issue first suggesting the enhancement for consideration. For smaller changes, feel free to begin work without discussion beforehand. Follow these steps to open a pull request:

  1. Create a fork of the code.
  2. Do your changes on your fork.
    Prettier will run on commit to ensure your changes conform to code style guidelines.
    Ensure your changes pass linting by running npm run lint.
  3. Update the 'Unreleased' release notes section in RELEASE_NOTES.md.
  4. Open a pull request against this repo with your changes.

I will help you to get changes merged into the repo, and release them onto NPM in a new version as soon as possible.