2016-04-18 11:50:29 -07:00
|
|
|
Contributing to FingerprintJS2
|
|
|
|
|
==============================
|
|
|
|
|
|
|
|
|
|
## Found a bug?
|
|
|
|
|
|
|
|
|
|
Please submit an issue.
|
|
|
|
|
Include in the issue:
|
|
|
|
|
|
|
|
|
|
* List of components you received in the `get` call (make sure values are not truncated)
|
|
|
|
|
* If FP is different every time you call the library, include 2 versions of components
|
|
|
|
|
* Include your OS version
|
|
|
|
|
* Include steps to reproduce
|
|
|
|
|
* Include library call code (I need all options you used when calling the library function)
|
|
|
|
|
|
|
|
|
|
## Want to add a feature / contribute?
|
2016-05-21 19:29:03 -07:00
|
|
|
* Make sure the issue/suggestion does not exist by searching existing issues
|
2016-04-18 11:50:29 -07:00
|
|
|
* Fork the project and make the required changes in it (don't forget to add specs)
|
|
|
|
|
* PRs w/out specs will not be accepted
|
|
|
|
|
* Run `gulp` to catch stylistic errors and produce the minified version.
|
|
|
|
|
* Run specs by opening the `specs/spec_runner.html` or typing `npm test` (requires phantomjs for console running).
|
|
|
|
|
* Make a PR.
|
|
|
|
|
* Make sure you only make one commit per feature you want to add
|
|
|
|
|
* Make sure your commit message is descriptive and tells what you changed (`Updated the library` - that's a bad commit message)
|
|
|
|
|
|
|
|
|
|
If your code changes the list of fingerprinting sources, please update
|
|
|
|
|
the README.
|
|
|
|
|
|
|
|
|
|
If you're unsure about the feature you want to add, submit an issue with
|
|
|
|
|
a `question` tag.
|
|
|
|
|
|
|
|
|
|
## Want to ask?
|
|
|
|
|
* Please read FAQ first
|
|
|
|
|
* If you have not found the answer you were looking for - use gitter.im to ask your question (link is in the readme)
|
|
|
|
|
|
|
|
|
|
Happy Coding!
|
