Skip to content
This repository has been archived by the owner on Jan 27, 2025. It is now read-only.

Latest commit

 

History

History
22 lines (17 loc) · 1.11 KB

CONTRIBUTING.md

File metadata and controls

22 lines (17 loc) · 1.11 KB

Contributing

Contributions are always welcome. To contribute, fork this repo, commit your changes, and open a pull request against master.

Pull request

Pull requests must have unit tests, or if there's some additional browser specifics in the implementation, a Browserstack test is great. We want to keep the code coverage as high as possible.

Issue

There might be some issues, so if you find one, you're encouraged to fix it, or create an issue in this repo.

Documentation

If you have a documentation issue or pull request, please open a ticket or a PR. We're also happy to better the docs outside of the readme sections.

Code quality

Use the lint config attached, and you'll be fine, but to keep things consistent, we'd like to keep:

  • file names as all lower-cased in kebab style ( e.g. live-connect.js)
  • use old school functions on the top level and write as much JS Doc as possible
  • one liner functions can use arrow functions
  • the hierarchy as is

Of course, all these might change, we're open to it.