Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
68 lines (52 loc) · 1.76 KB

CONTRIBUTING.md

File metadata and controls

68 lines (52 loc) · 1.76 KB

Contributing

Thanks for contributing to YouTube Local Library! We're quite open to new feature requests, or any work you want to do.

Please note we have a code of conduct, please follow it in all your interactions with the project.

Creating Issues

When creating issues please follow the according template structure:

Contributor Workflow

The codebase is maintained using the "contributor workflow" where everyone without exception contributes patch proposals using "pull requests". This facilitates social contribution, easy testing and peer review.

To contribute a patch, the workflow is as follows:

  • Fork repository
  • Create topic branch
  • Commit patches

If you send a pull request, please do it against the main branch.

Set up a local dev environment

To set up a local dev environment following steps are required:

  1. Fork this repository
  2. Clone:
git clone git@github.com:[YOUR_USERNAME]/youtube-local-library-ff.git
  1. Go into cloned repository folder:
cd youtube-local-library-ff
  1. Install yarn:
yarn install
  1. Build project using Gulp:
yarn build

or watch changes:

yarn watch
  1. Install the web-ext package:
yarn add --global web-ext
  1. Run the start command to execute the web-ext package (web-ext run) to refresh extension on change (a browser window should open with the addon):
yarn start

Codestyle

This project uses ESLint to validate and lint JavaScript code.

To lint the code run:

yarn lint