Skip to content

Latest commit

 

History

History
46 lines (35 loc) · 1.93 KB

CONTRIBUTING.md

File metadata and controls

46 lines (35 loc) · 1.93 KB
Raw

Contributing

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

  • join slack #compass
  • add an example to README.md
  • scratch an itch and implement a new feature using our workflow

Workflow

  1. Fork the repository on GitHub
  2. Create a branch with a name that briefly describes your feature
  3. Implement your feature or bug fix
  4. Add new cases to ./tests.js that verify your bug fix or make sure no one unintentionally breaks your feature in the future and run them with npm test
  5. Add comments around your new code that explain what's happening
  6. @todo: Run npm run-script check to tidy up your code and show you where you might want to change things to be safer or easier to use
  7. Commit and push your changes to your branch then submit a pull request

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

Bugs

It would be extremely helpful, if you have the time, to look at existing bugs and help us understand if:

  • The bug is reproducible?
  • Is it reproducible in other environments (browsers)?
  • If they weren't included originally, what are the steps to reproduce?

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 v6.3.1 on macOS Sierra"). 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.