Skip to content

Latest commit

 

History

History
36 lines (27 loc) · 1.44 KB

CONTRIBUTING.md

File metadata and controls

36 lines (27 loc) · 1.44 KB
Raw

Contributing

Great to have you here. These are a few ways you can help make this project better:

Workflow

  1. Fork the repository on GitHub
  2. Create a new branch with a name that breifly describes your feature
  3. Implement your feature or bug fix
  4. Add new cases to ./test/index.test.js and run them with npm test
  5. Add comments around your new code that explain what's happening
  6. Commit and push your changes to your branch
  7. Submit a pull request

Don’t get discouraged! We estimate that the response time from the maintainers is less than 24 hours.

Bugs

You can report new bugs by creating a new issue. Please include as much information as possible about your environment ("I am using node.js v 0.12.0 on OSX Mavericks"). Actual code is always more valuable than an explanation, so please include a link to a GitHub gist or include a snippet directly in your issue description.

Versioning

This library aims to adhere to Semantic Versioning2.0.0. Violations of this scheme should be reported as bugs. Specifically, if a minor or patch version is released that breaks backward compatibility, that version should be immediately yanked and/or a new version should be immediately released that restores compatibility.