contribute

notnac edited this page May 7, 2018 · 28 revisions

Contribute

Code

PLEASE NOTE: get_iplayer is in maintenance mode, so pull requests that add new features will not be accepted. If you wish to add new features, you must take over as maintainer. Bug fixes will still be accepted.

If you would like to contribute a bug fix to get_iplayer, fork the repository on GitHub and submit a pull request with your changes (GitHub account required). See GitHub help documentation for basic information on forking a repo and creating a pull request. The get_iplayer project repo is:

https://github.com/get-iplayer/get_iplayer

Follow a few basic guidelines for pull requests:

  • Each pull request should be submitted from its own feature branch in your fork of the repository. This will make it easier to manage further changes after the pull request is submitted.

  • You should base your feature branch on the contribute branch in the get_iplayer repo, so create it similar to:

      git checkout -b feature/bugfix contribute
    
  • Each pull request should contain a fix for a single bug.

  • Each pull request should contain only one commit unless there are exceptional reasons to do otherwise.

  • Each pull request should be independent of changes made in any other pull request.

  • get_iplayer uses tabs for indentation - not spaces - and so must the changes in your pull request.

  • Run git diff --check on your code before committing to ensure you don't have whitespace errors. If you do, fix them before submitting your pull request.

  • Make sure your patches apply cleanly to the current contribute branch in the get_iplayer repo, otherwise they may be rejected. Don't expect committers to fix your code.

  • If you are not able to test your code on at least one version each of Linux/BSD, macOS and Windows, say so in your pull request description. If that is the case, your pull request is less likely to be accepted, but it is necessary for committers to know what testing may be required.

Support

Help answer queries in the support forums:

https://squarepenguin.co.uk/forums/

Documentation

If you would like to contribute documentation, you can edit the project wiki (GitHub account required):

https://github.com/get-iplayer/get_iplayer/wiki

Mailing List

There is a mailing list for get_iplayer:

http://lists.infradead.org/mailman/listinfo/get_iplayer

Money

The developer does not accept financial contributions of any kind. Give generously to your favourite charity or another open source project.

You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.