Skip to content

Latest commit

 

History

History
63 lines (46 loc) · 3.66 KB

CONTRIBUTING.md

File metadata and controls

63 lines (46 loc) · 3.66 KB
Raw

How to contribute

If you would like to contribute to the project please follow the guidelines set out below. Keep in mind that they are not here to make your contribution a painful experience, but to simplify our jobs looking through hundreds of issues and pull requests (making it a 30 minute task instead of a 4 hour job!)

Pull Request

Pull Request for new feature, bugs or translations are often appreciated. However pleasae follow the following guidelines to save as much time as possible for the maintainer.

  • Make your commit message as descriptive as possible. Include as much information as you can. Explain anything that the file diffs themselves won’t make apparent.
  • Document your pull request. Explain your fix, link to the relevant issue. A pull request without any comment will get close.
  • Consolidate multiple commits into a single commit when you rebase. If you’ve got several commits in your local repository that all have to do with a single change, you can squash multiple commits into a single, clean, descriptive commit when using git-rebase. When you do, good karma is yours.
  • Make sure the target of your pull request is the relevant dev branch. Most of bugfix or new feature should go to the dev branch. Translation work should go into translation branch.
  • Include only commits fixing a specific issue. If your pull request has unrelated commit, it will get closed.

Translation

Most of the pull request are translation request. Following not only save hours of work for the maintainers, it will make your pull request merged without any question asked and everyone are going to be happy about this.

  • Fetch translation branch with git fetch origin translations and git checkout translations.
  • Run git pull often since there's frequent translation changes.
  • When you create your pull request, make sure it is from and to the translations branch of both repository.

UI changes

If your pull request made some changes on the UI, your pull request must contains the following:

  • In the case of major new feature, a link to issue where the design was discussed.
  • In every case, a screenshot of the new UI that shows your changes.

Report a bug

Before reporting any issues, please use the search tools to see if someone filed the same bug before.

When creating a new issue make sure to include the following:

  • Version of Popcorn Time used. Are you running from source? Which revision? Are you using a released build? Which release?
  • Your environment. What is your operating system? 32 or 64 bits?
  • Step to reproduce. Even if the step is only to open the app, include it! Include the actual result and what you expected.
  • Messages you get when running from console with the --debug parameter.
  • A screenshot of any visual bug.

Here is what a great bug report would look like:

Movie not playing

Version: Release 0.2.7 for Windows
OS: Windows 7
How to reproduce:
 - Open Popcorn-Time
 - Click on the `Frozen` movie in `popular` category
 - Click "Watch it now"
 - Wait for movie to download
Actual result:
 - The movie player stay black with a spinning wheel for at least 10 minutes
Expected result:
 - The movie start

Console output:
[6239:0317/031639:INFO:CONSOLE(0)] "event.returnValue is deprecated. Please use the standard event.preventDefault() instead.", source:  (0)
...

Feature suggestions

Feature suggestions should go to the UserVoice portal. Please open an issue if you plan to develop it or want to go through design discussion and review before making progress. Issues such as It would be nice to support XXX are usefull to no one, use the wiki page.