Skip to content
This repository has been archived by the owner on May 3, 2019. It is now read-only.

Commit

Permalink
Fix sphinx-build warnings in contributing.rst
Browse files Browse the repository at this point in the history
Convert contributing.md to rst using pandoc

Fix #199
  • Loading branch information
ColinDuquesnoy committed Feb 11, 2018
1 parent 1a75e49 commit 8610e95
Showing 1 changed file with 81 additions and 1 deletion.
82 changes: 81 additions & 1 deletion docs/developers/contributing.rst
Original file line number Diff line number Diff line change
@@ -1 +1,81 @@
.. include:: ../../CONTRIBUTING.rst
Contributing to MellowPlayer
============================

Reporting bugs or Wishes
------------------------

Report any bugs you encountered or any wishes on our `issue tracker`_.

If you’re reporting a bug, **make sure to provide the following
information**:

- Information about your **Operating system** (e.g. Windows 8.1, Mac
OSX Yosemite,…). If you’re on Linux, you’ll need to specify the name
of the distribution and the desktop environment you’re using and
whether you’re using a native package or the AppImage.
- The **music streaming service** that you were using when you
encountered the bug if related to a specific streaming service.
- A **clear description** of the bug with **steps to reproduce**.
- You should use **English** to describe your issue. French is also
accepted.
- Paste the application log between triple backquotes
``(About > Show Logs)``.

Setting up a development environment
------------------------------------

Read the how to setup page of the `wiki`_

We also recommend you read the `architecture`_ and the `coding
guidelines`_ pages before hacking on MellowPlayer.

Submitting a pull request
-------------------------

Here are the steps you need to follow to start working on MellowPlayer
and submit your work for evaluation or integration into the main
project:

1. Fork the Repo on github.
2. Create a feature or a bugfix branch before you start coding.
3. Add your name to AUTHORS.md
4. Format the code using ``scripts/beautify.py`` (run it from the root
source directory).
5. Push to your fork and submit a pull request to **the develop
branch**.

Adding support for a new service
--------------------------------

Web streaming service integration plugins are now written in pure
javascript.

1. Create a new plugin using the wizard (see
http://mellowplayer.readthedocs.io/en/webengine/developers/plugins.html#create-a-new-plugin)
2. Edit ``metadata.ini`` (add correct url, name, version,…)
3. Edit ``description.html`` to describe the streaming service
4. Customise logo.svg
5. Implement the needed functions in ``integration.js``
6. Once your plugin works, submit a pull request to **the develop
branch**.

Adding/Updating a new translation
---------------------------------

MellowPlayer translations are hosted on `transifex`_

- Create an account at transifex
- Go to the project’s homepage and click on the “Join the team” button
- If the language you want to work on does not exists yet, send us a
language request. Once the request has been accepted, a new
translation file for the requested language will be created
automatically by transifex.
- To actually start translating, go to the project’s home page on
transifex and click on the tr

.. _issue tracker: https://github.com/ColinDuquesnoy/MellowPlayer/issues
.. _wiki: https://github.com/ColinDuquesnoy/MellowPlayer/wiki
.. _architecture: https://github.com/ColinDuquesnoy/MellowPlayer/wiki/Architecture
.. _coding guidelines: https://github.com/ColinDuquesnoy/MellowPlayer/wiki/Coding-guidelines
.. _transifex: https://www.transifex.com/colinduquesnoy/mellowplayer

0 comments on commit 8610e95

Please sign in to comment.