Skip to content
This repository has been archived by the owner on Jun 1, 2022. It is now read-only.

Latest commit

 

History

History
27 lines (16 loc) · 1.73 KB

CONTRIBUTING.md

File metadata and controls

27 lines (16 loc) · 1.73 KB

Contributing to Plex Media Player

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

The following is a set of guidelines for contributing to Plex Media Player.

1 - Read the Plex CLA

Before commiting, you will need to read the CLA which can be found in our wiki

Your commit message should include a sign off to confirm you've accepted the CLA by ending the commit with:

Plex-CLA-1.0-signed-off-by: Your Name [email protected]

2 - General Guidelines

There are a few things you should verify before submitting a PR to Plex Media Player.

  • Commit messages should be clear and start with the topic being addressed. An example would be: topic : description. ie player : what it fixes ...
  • Take time to write a clear and understandable commit message description. Most of the time the commit title is not enough to describe the patch and why it's required. Think of the fact that Plex Media Player is running on multiple platforms and that there are other context than your.
  • Ensure that the patch you're submitting does not break other platforms. For instance if you are making a patch that is specific to MacOS, it shouldn't impact Windows or Linux builds.
  • Respect the coding convention currently used, whilst we have no detailed documentation to cover the coding style you can make sure your patch matches the existing conventions.

3 - Merge process

  • Once you've submitted the Pull Request to the repo, please be patient. It will be reviewed by multiple members of Plex who will reply with comments.
  • Once the change has been verified, it will be merged once all PR comments have been addressed.