Skip to content

Latest commit

 

History

History
76 lines (56 loc) · 3.06 KB

CONTRIBUTING.md

File metadata and controls

76 lines (56 loc) · 3.06 KB
Raw

How to contribute

We'd love to accept your patches and contributions to this project. There are just a few small guidelines you need to follow.

  1. File a bug at https://github.com/shaka-project/shaka-player/issues (if there isn't one already). If your patch is going to be large, you should start a discussion on GitHub first.

    Leave a comment to let us know that you are working on a PR for the issue. We'll assign the issue to you.

  2. For legal reasons, all contributors must sign a Contributor License Agreement, either for an individual or corporation, before a patch can be accepted. (See below.)

  3. Follow the normal process of forking the project, and setup a new branch to work in. It's important that each group of changes be done in separate branches in order to ensure that a pull request only includes the commits related to that bug or feature.

  4. Add an entry to the AUTHORS and CONTRIBUTORS files with your name and email. For corporate contributions, AUTHORS should contain an entry for your company.

  5. Do your best to have well-formed commit messages for each change. This provides consistency throughout the project, and ensures that commit messages are able to be formatted properly by various git tools.

  6. Add or modify unit or integration tests for any new or modified functionality in your patch. For bug fixes, try to write a regression test that fails without your patch and passes with it. Our tests are written with Jasmine.

  7. Test all changes in both the compiler and linter with:

   python build/all.py

Patches that do not compile or pass linter checks will not be accepted.

  1. Test all changes in the unit and integration tests with:
   python build/test.py

Patches that do not pass unit and integration tests will not be accepted.

  1. Finally, push the commits to your fork and submit a pull request.

Contributor License Agreement

Contributions to any Google project must be accompanied by a Contributor License Agreement. This is not a copyright assignment, it simply gives Google permission to use and redistribute your contributions as part of the project.

  • If you are an individual writing original source code and you're sure you own the intellectual property, then you'll need to sign an individual CLA.

  • If you work for a company that wants to allow you to contribute your work, then you'll need to sign a corporate CLA.

You generally only need to submit a CLA once, so if you've already submitted one (even if it was for a different project), you probably don't need to do it again.