Contributing

Welcome!, and many thanks in advance if you finally decide to contribute to Tizonia.

The following is a set of guidelines for contributing to the project, definitely not rules. Use your best judgement, and feel free to suggest changes.

• How Can I Contribute?

  • Reporting Bugs

  • Suggesting New Features

  • Improving the Documentation

  • Contributing with Code

  • Spreading the Word

• Resources

Issue Labels

How Can I Contribute?

Reporting Bugs

Bug reports are absolutely necessary to keep the project alive. When you are creating a bug report, please provide as many details as possible.

Suggesting New Features

You are more than welcome to submit ideas for new features and enhancements through the bug tracker, just include as many details as you can, including potential implementation options.

Improving the Documentation

Documentation is always a work-in-progress. Doxygen and Sphinx are the tools we use to produce the official documentation. We also have a Wiki (in need of some love!):

• See docs.tizonia.org for the project’s official documentation.

• The Wiki may also contain some useful information (although in need of an update).

Here there is a tutorial that will get you going quickly with the documentation processes:

• https://docs.tizonia.org/development/documenting.html

Contributing with Code

Tizonia has a hybrid codebase with some modules written in C, other written in C++ and some other written in Python. There are also various tools that are written in Bash and Perl.

Unsure where to begin? You can start by looking through the good-first-issue or help-wanted issues:

• Good first issues - issues which should only require a few lines of code.

• Help wanted issues - issues which should be a bit more involved than good-first-issue issues.

There are also a good number of proposed features that should be quite fun for someone looking for a challenge:

• Enhancements - Newly proposed features and other improvements.

Have a look at the project’s components, and follow the instructions to build and run the codebase locally.

• Build Tizonia from source (with Meson) (RECOMMENDED).

• Build Tizonia from source (with Autotools).

And of course, don’t hesitate to ask!.

Spreading the Word

Do you use Tizonia and have fun with it?. Do you enjoy listening to your music easily and without fuss, directly from your command-line? Then why not spreading the word among colleagues and friends.

Or simply starring any of the repositories in the Tizonia organization would be a good way of showing your appreciation.

Resources

• See PROJECT.md to learn about the various parts of project.

• See ROADMAP.md for a view on what things are coming next.

• See CODE_OF_CONDUCT.md to keep Tizonia an open and welcoming environment.

• See BUILDING_with_meson.md (RECOMMENDED) for instructions on how to build Tizonia from source (with the new Meson build system).

• See BUILDING.md for instructions on how to build Tizonia from source (with the legacy Autotools build system).

• See docs.tizonia.org for the project’s official documentation.

• The Wiki may also contain some useful information (although in need of an update).

• See CHANGELOG.md for details on what has gone into each release of the project.

• Tizonia OpenMAX IL is released under the GNU Lesser General Public License version 3.

• Finally, please visit the project web site at https://tizonia.org