CONTRIBUTING.md

Contributing to YouTube.js

Thank you for taking the time to contribute! The following is a set of guidelines for contributing to YouTube.js.

---

• Issues

  • Create a new issue
  • Solve an issue

• Make changes

  • Commit your updates
  • Create a PR
  • Run tests
  • Lint your code
  • Build for node
  • Bundle for browsers
  • Compile proto file
  • Build parser map

Issues

Create a new issue

If you find a problem, search if an issue already exists. If a related issue doesn't exist, you can open a new issue using a relevant issue form.

Solve an issue

Scan through the existing issues to find one that interests you. You can narrow down the search using labels as filters. If you find an issue to work on, you are welcome to open a PR with a fix.

Make changes

1. Fork the repository
2. Install or update to Node.js v16
3. Create a working branch and start with your changes!

Commit your updates

Commit the changes once you're happy with them.

Pull Request

When you think the code is ready for review a pull request should be created on Github. Owners of the repository will watch out for new PR‘s and review them in regular intervals.

• Fill the template.
• Link the PR to an issue, if you are solving one.
• Enable the checkbox to allow maintainer edits so the branch can be updated for a merge.
• Changes may be requested before a PR can be merged.
• As you update your PR and apply changes, mark each conversation as resolved.

Test

npm run test

Lint

npm run lint

Or

npm run lint:fix

Build for Node

npm run build:node

Build for browsers

npm run build:browser

Or:

npm run build:browser:prod

Compile proto file

// TODO

Build parser map

npm run build:parser-map