Skip to content

Latest commit

 

History

History
31 lines (23 loc) · 1.29 KB

CONTRIBUTING.md

File metadata and controls

31 lines (23 loc) · 1.29 KB

Contributing Guide

Requesting a feature

  1. Open an issue on GitHub
  2. Include a description of the desired feature
  3. Include an example input and output
  4. Consider opening a Pull Request

Reporting an Issue

  1. Open an issue on GitHub
  2. Include any logs or stacktraces in a Markdown fenced block
  3. Consider opening a Pull Request resolving the issue.

Contributing Code

  1. First time opening a Pull Request? Checkout this Pull Request guide!
  2. Create a fork of the repository
  3. Clone the fork
  4. Install npm dependencies npm install
  5. Make changes
  6. Ensure changes pass tests npm test
  7. Commit changes npm run-script commit
  8. Push changes to GitHub
  9. Open a Pull Request

Additional Resources