| 1 | # CONTRIBUTING
|
| 2 |
|
| 3 | By contributing you agree to the [LICENSE](LICENSE) of this repository.
|
| 4 |
|
| 5 | ## Issue Tracker
|
| 6 |
|
| 7 | - before submitting a new issue, please:
|
| 8 |
|
| 9 | - check for existing related issues
|
| 10 |
|
| 11 | - check the issue tracker for a specific upstream project that may be more appropriate
|
| 12 |
|
| 13 | - check against supported versions of this project (i.e. the latest)
|
| 14 |
|
| 15 | - please DO NOT comment with a "+1", use the Subscribe button instead
|
| 16 |
|
| 17 | - please keep discussions on-topic, and respect the opinions of others
|
| 18 |
|
| 19 | - please report urgent issues, or issues with confidential details, via our commercial support channels
|
| 20 |
|
| 21 |
|
| 22 | ### Security Vulnerabilities
|
| 23 |
|
| 24 | - please contact us privately to discuss security vulnerabilities as part of our [responsible disclosure](https://en.wikipedia.org/wiki/Responsible_disclosure) approach
|
| 25 |
|
| 26 | ### Bug Reports
|
| 27 |
|
| 28 | - please report bugs in the [issue tracker](https://github.com/blinkmobile/bm-identity.js/issues)
|
| 29 |
|
| 30 | - please provide detailed steps to reproduce
|
| 31 |
|
| 32 | ### Feature Requests
|
| 33 |
|
| 34 | - please suggest new features and improvements in the [issue tracker](https://github.com/blinkmobile/bm-identity.js/issues)
|
| 35 |
|
| 36 | ### Personal Support Requests
|
| 37 |
|
| 38 | - please submit urgent requests for help via our commercial support channels
|
| 39 |
|
| 40 | - requests for help in the [issue tracker](https://github.com/blinkmobile/bm-identity.js/issues) receive lower priority than commercial support requests
|
| 41 |
|
| 42 | ## Pull Requests / Merge Requests
|
| 43 |
|
| 44 | - **IMPORTANT**: by submitting a patch, you agree to allow the project owners to license your work under our this [LICENSE](LICENSE)
|
| 45 |
|
| 46 | - provide tests for all features or bug fixes
|
| 47 |
|
| 48 | - provide documentation for all public API methods
|
| 49 |
|
| 50 | - Pull / Merge Request descriptions should include a change summary that matches the [Keep a CHANGELOG](http://keepachangelog.com/) format
|
| 51 |
|
| 52 | - this project uses the [Git Flow](http://nvie.com/posts/a-successful-git-branching-model/) branching scheme, so changes should target the "develop" branch
|
| 53 |
|
| 54 | - feel free to submit un-squashed commits provided tests pass for all commits
|
| 55 |
|
| 56 | ## Code Style and Code Quality
|
| 57 |
|
| 58 | - adhere to our code style guides
|
| 59 |
|
| 60 | - [](https://github.com/Flet/semistandard)
|
| 61 |
|
| 62 | - run `npm test` to ensure your changes follow our coding standards and pass our existing tests
|
| 63 |
|
| 64 | ## Version Control
|
| 65 |
|
| 66 | - this project adheres to [Semantic Versioning](http://semver.org/)
|
| 67 |
|
| 68 | - ideally, highlight when work would change the API surface in ways that break compatibility with existing consumers
|
| 69 |
|
| 70 | - compose meaningful version control comments: http://alistapart.com/article/the-art-of-the-commit
|
| 71 |
|
| 72 | ## Development
|
| 73 |
|
| 74 | ### Prerequisites
|
| 75 |
|
| 76 | __coming soon__
|
| 77 |
|
| 78 | ### Getting Started
|
| 79 |
|
| 80 | __coming soon__
|