This is a document guiding you on how to contribute to Live Stream Notifier. It is separated by contribution nature and not limited to code contributions.
Reporting issues directly on GitHub is more than welcome. Please include debugging data that is obtained by Shift and clicking on the Help button in the Channels Manager. It should not include any directly personal data, however it will contain all channels and users and their current state as well as things like your operating system and extension version.
You can help to translate the extension on Transifex. If your language doesn't exist yet, just request a new team for it and I'll approve it as soon as possible.
I try to give as much contextual information as possible on Transifex. The glossary contains some common words, sometimes there are specific translation instructions or screenshots (in the string comments). If you're unsure where the string would be used, check the name of the string key, it generally contains whatever part it belongs to and if it's a label or whatever.
All strings for settings are tagged as "settings" and everything in the Channels Manager is tagged as "cm".
If you are versed in JavaScript, especially in writing es2015 modules, you can try to write a module for a provider. If you don't have an idea for a provider to add, check all issues with the provider tag.
All code relevant to writing a provider module should be pretty well documented in JSDoc syntax, except for the existing provider implementations.
The new provider module will be in the providers folder. The generic-provider in that folder implements a base class off of which I'd suggest to base your provider on. It documents the full interface your provider should implement. Please note that "private" properties of the Class are prefixed with an _ if they need access to this, else they are defined outside the Class.
Providers have properties that define which features they support. All providers are expected to support adding channels by some kind of username and updating their live state.
Further helpers include the queue/service, which is already included with the GenericProvider by default, and the pagination-helper. The returned Channel and User objects are from channel/core. A read-only version of the users and channels of a provider is available as a provder-list.
To include your provider with the actual extension, export it in the providers module. The property you export it on should match the type string you put on the returned Channel and User objects.
After the provider works, you'll have to add a string for the provider name in the locales file and add styling for the panel in the list.css. You have to define two rules, as done for all the existing providers. The class name for your provider is the type string you specified.
This extension consists mostly of es2015 modules that get combined with webpack and some actual HTML/CSS. The list popup is written in React, everything else is more or less vanilla JS.
The modules are sometimes documented, sometimes not. I'm trying to document all modules, but it's a do it as you go thing. The web components aren't well documented at all and are sometimes very big, hard to navigate files.
I will accept all pull requests, whenever I feel like it's reusing the same
coding style as was used before. Yes, there are no formal definitions for the
style, however at least for JS the linter should force in the right direction.
Please run npm test locally before submitting your pull request and unless the
travis CI badge on the README says failing, the command should not
fail before you submit the pull request.
I want to give recurring contributors direct access to the repository.