Skip to content

Latest commit

 

History

History
193 lines (127 loc) · 9.04 KB

CONTRIBUTING.md

File metadata and controls

193 lines (127 loc) · 9.04 KB
Raw

Contributing to Streamlink Twitch GUI

Want to get involved? Thanks! There are plenty of ways to help!

Reporting issues

A bug is a demonstrable problem that is caused by the code in the repository. Good bug reports are extremely helpful - thank you!

Please read the following guidelines before you report an issue:

  1. Use the GitHub issue search — check if the issue has already been reported. If it has been, please comment on the existing issue.

  2. Check if the issue has been fixed — the latest master or development branch may already contain a fix.

  3. Isolate the demonstrable problem — make sure that the code in the project's repository is definitely responsible for the issue.

Please try to be as detailed as possible in your report too. What is your environment? What steps will reproduce the issue? What would you expect to be the outcome? All these details will help people to assess and fix any potential bugs.

Feature requests

Feature requests are welcome. But take a moment to find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Please provide as much detail and context as possible.

Translating

Please see the detailed translation guidelines on the project's wiki.

Developing and building

Streamlink Twitch GUI is built on top of NW.js (formerly known as node-webkit).
Please visit the NW.js website if you want to know more about NW.js apps.

Building the application is simple. Please make sure that the latest stable versions of Git, Node.js and Yarn are properly set up on your system, so all dependencies can be installed and the application be tested, built, compiled and optionally packaged.

Unlike other Ember.js based projects which are built with ember-cli, Streamlink Twitch GUI uses Grunt and Webpack as build tools.

Setup

# clone the repository
git clone https://github.com/streamlink/streamlink-twitch-gui.git
cd streamlink-twitch-gui

# install the project's dependencies
yarn install

Grunt

In order to be able to run grunt from the command line shell, grunt-cli has to be installed.

If your system does not have a grunt-cli / node-grunt-cli / etc package available in its native package management system, or if you don't want to install grunt-cli globally via yarn (yarn global add grunt-cli), then you'll have to use the version which comes bundled with Streamlink Twitch GUI's build-dependencies. This bundled version requires you to either wrap its executable with the yarn run command (yarn run grunt) or to execute it directly from ./node_modules/.bin/grunt. If you're choosing the second option, ./node_modules/.bin/ can also be added to the PATH environment variable for quicker access, so you can just run grunt instead.

To get a list of all available grunt tasks, run grunt --help.
Task configs and custom task modules can be found in build/tasks/{configs,custom}.

Task aliases

Executing grunt without parameters is an alias for grunt build, which itself is an alias for grunt build:dev, which is again an alias for the task list for building and launching a development build.
See build/tasks/configs/aliases.yml for all available aliases.

Developing

grunt build

This will create a development build and will run NW.js afterwards. If NW.js has not been downloaded yet, it will do this automatically.
Since NW.js is based on Chromium, you will find all the usual debugging tools. These can be accessed by clicking the button in the titlebar of the application or by opening http://localhost:8888/ in your web browser. IDEs with internal Node/Chromium/NW.js debugging support can be used as well.
Once NW.js has been launched, file watchers will look for any changes being made to the source files and will then rebuild those parts of the application.
Closing NW.js while grunt is still running will automatically re-open it. To stop this, terminate/interrupt the grunt process with CTRL+C.

Testing

# run tests
grunt test

# show the NW.js window while running tests and keep rebuilding tests on change
grunt test:dev

# test and build a code coverage report (see build/tmp/coverage)
grunt test:coverage

I18n coverage

# show missing, invalid or unused translation strings
grunt webpack:i18n

Building and compiling

# create a production build and compile it afterwards
grunt release
# or run both build steps explicitly
grunt build:prod compile

The final build can be found in the build/releases directory.

Both the release and compile tasks support multiple targets for different platforms. Targets can be set by appending :target to the task name (eg. grunt release:linux64:osx64). See build/tasks/common/platforms.js for all available targets. By default, the currently used platform will be selected. Compiling a win32 or win64 build on Linux or macOS requires wine to be installed on the system.

Archives, installers and packages

Distribution files can optionally be built after successfully compiling a production build. For building archives, a *nix environment is required, for building tarballs, GNU tar has to be installed, and for building the Windows installers, NSIS has to be set up on the system.

# see the dist grunt task config for the available distribution targets
grunt dist:all

Reproducible builds

Reproducible builds are supported (excluding the NSIS installers). If you want to compare an official build with a local build, check out the tagged git commit first and then set the SOURCE_DATE_EPOCH environment variable to the value of git show -s --format=%ct before building, compiling and packaging.

Pull requests

Good pull requests - patches, improvements, new features - are a fantastic help. They should remain focused in scope and avoid containing unrelated commits.

Please ask first before embarking on any significant pull request (e.g. implementing features, refactoring code, porting to a different language), otherwise you risk spending a lot of time working on something that the project's developers might not want to merge into the project.

Please adhere to the coding conventions used throughout a project (indentation, white space, accurate comments, etc.) and any other requirements (such as test coverage).

Adhering to the following process is the best way to get your work included in the project:

  1. Fork the project, clone your fork, and configure the remotes:

    # Clone your fork of the repo into the current directory
git clone [email protected]:<YOUR-USERNAME>/streamlink-twitch-gui.git
# Navigate to the newly cloned directory
cd streamlink-twitch-gui
# Assign the original repo to a remote called "upstream"
git remote add upstream https://github.com/streamlink/streamlink-twitch-gui.git

  2. If you cloned a while ago, get the latest changes from upstream

    git checkout master
git pull upstream master

  3. Create a new topic branch (off the main project branch) to contain your feature, change, or fix:

    git checkout -b <TOPIC-BRANCH-NAME>

  4. Commit your changes in logical chunks. Please adhere to these git commit message guidelines or your code is unlikely be merged into the project. Use git's interactive rebase feature to tidy up your commits before making them public.

  5. Locally merge (or rebase) the upstream branch into your topic branch:

    git pull [--rebase] upstream master

  6. Push your topic branch up to your fork:

    git push origin <TOPIC-BRANCH-NAME>

  7. Open a Pull Request with a clear title and description.

IMPORTANT: By submitting a patch, you agree to allow the project owners to license your work under the terms of the MIT License.

Acknowledgements

This contributing guide has been adapted from HTML5 boilerplate's guide.