By contributing you agree to the LICENSE of this repository.
-
before submitting a new issue, please:
-
check for existing related issues
-
check the issue tracker for a specific upstream project that may be more appropriate
-
check against supported versions of this project (i.e. the latest)
-
-
please DO NOT comment with a "+1", use the Subscribe button instead
-
please keep discussions on-topic, and respect the opinions of others
-
please report urgent issues, or issues with confidential details, via our commercial support channels
- please contact us privately to discuss security vulnerabilities as part of our responsible disclosure approach
-
please report bugs in the issue tracker
-
please provide detailed steps to reproduce
- please suggest new features and improvements in the issue tracker
-
please submit urgent requests for help via our commercial support channels
-
requests for help in the issue tracker receive lower priority than commercial support requests
-
IMPORTANT: by submitting a patch, you agree to allow the project owners to license your work under our this LICENSE
-
provide tests for all features or bug fixes
-
provide documentation for all public API methods
-
Pull / Merge Request descriptions should include a change summary that matches the Keep a CHANGELOG format
-
this project uses the Git Flow branching scheme, so changes should target the "develop" branch
-
feel free to submit un-squashed commits provided tests pass for all commits
-
adhere to our code style guides
-
-
run
npm testto ensure your changes follow our coding standards and pass our existing tests
-
this project adheres to Semantic Versioning
- ideally, highlight when work would change the API surface in ways that break compatibility with existing consumers
-
compose meaningful version control comments: http://alistapart.com/article/the-art-of-the-commit
coming soon
coming soon