Contributing

From The Player Project

Revision as of 20:23, 16 October 2011 by Rmattes (Talk | contribs)
Jump to: navigation, search

The Player project welcomes community contributions, especially well written patches that apply cleanly to the svn trunk. If you want to contribute but are not sure where to start have a look at the feature request or bug trackers, or help improve the documentation (be it the Wiki, the manual, or a contributed tutorial).

In addition to the Wiki, the Player mailing lists are friendly places to get info and ask questions if anything is unclear.

Contents

Code contribution

As an open source project, licensing of contributions is important. Here are the requirements for contributions to Player.

  1. You must have the right to contribute the code under the given license (either as author of the work or through a license given to you)
  2. All contributed source files must contain a suitable copyright header at the top of them. Have a look at the templates in the top level of the source distribution for examples, or existing source files.
  3. Contributions of examples must be under a BSD or similar license.
  4. Contributions of drivers or utilities must be a GPL compatible license (LGPL fulfils this). Currently Player still uses the GPL v2.
  5. All other contributions of code must be LGPL compatible.
  6. Contributions should be tested for errors and functionality before they are submitted.

These guidelines are in place to:

  1. Keep things simple and orderly
  2. Maximize the usefulness of the Player project, while still encouraging contribution of features and fixes.

Once you have a patch that you feel you would like to contribute, submit it to the Patches tracker on Player's SourceForge project page.

Where to Start

If you're interested in contributing to the Player project but don't know where to start, don't worry. There are plenty of things that can be improved, and we're always looking for contributers to do so!

Drivers

If you have access to a useful device that Player doesn't support, consider writing and contributing a new driver for it. If you've got a slick new planning algorithm, you can turn that into a driver too.

Roadmap

The goals for Player's future development are all laid out on the Roadmap page. Feel free to jump in and tackle one of the bulletpoints for the next release (or a previous release we missed!)

Documentation

Developing software is pointless if people can't figure out how to use it. Player has lots of documentation on the Wiki, as well as doxygen-generated documentation on the Player Web site. Editing pages for correctness, adding missing documentation about features, or adding new tutorials and how-to's are all useful to the community at large. testing

Personal tools