Skip to content
This repository has been archived by the owner on Feb 10, 2023. It is now read-only.

Latest commit

 

History

History
19 lines (14 loc) · 1.11 KB

CONTRIBUTING.md

File metadata and controls

19 lines (14 loc) · 1.11 KB

Contributing

Thank you for your interest in contributing to this repo! All contributions (even small ones) are welcome. You can contribute either by submitting a new issue for a bug you encountered, or by fixing a reported bug.

Reporting a bug

To report a bug in this package, fill in a new issue. Please provide all the details needed to reproduce your bug, including your versions Node.js and this package. A minimal failing test case is usually a good way to report a bug.

Fixing a bug

  1. Fork this repository.
  2. Clone your fork locally.
  3. Run npm install to install development dependencies.
  4. Checkout to a new branch named appropriately. This name should reflect the bug you tackle, eg. if you had fixed the issue "Improve documentation", you could have chosen improve-docs.
  5. Make your changes!
  6. If you introduced new features, don’t forget to add test cases for them.
  7. Make sure all tests run successfully (npm run test) and that your code complies to the style guide (npm run lint).
  8. Submit a pull request.