Contributing guide

Getting started

Thank you for considering contributing to Polyphone! You can find the documentation here and the website here.

To start working on contributions, create your own fork of this project, then clone it to your machine. For each bug, feature, etc. that you want to contribute, create a branch within your fork. For example, if you want to fix a UI issue, make a branch in your fork that is descriptive (ex. fix-ui-error), and make your changes there. You can then make a pull request from that branch.

Building

Instructions for building can be found for each platform on the documentation. Here are the direct links for each platform:

• Windows
• Mac OS X
• Fedora
• Ubuntu
• Building with Qt Creator

Reporting Bugs

To report a bug, be as descriptive as possible. This includes mentioning what platform you are using, steps to reproduce, and any additional notes that may be necessary to understand the bug. Not every detail is needed for each bug (ex. listing processor architecture for a ui issue) but is preferred, and may be asked about if needed.

Template

1. Polyphone Version
2. Platform (ex. Windows 10 | version xxxx | os build xxxxx.xxxx)
3. Processor/architecture (Intel, AMD, M-series)
4. What the issue is
5. How to reproduce it
6. What it should actually do

Suggesting features or enhancements

Feature and enhancement suggestions are welcome, and can be done by making an issue. You can include additional information, like the problem it solves or suggested implementation methods.

Making a Pull Request

To make a pull request, make sure that you do it with a branch. It would be helpful to provide detailed information about what the PR adds/changes.

Template

1. Issue that the PR fixes if applicable
2. Description of changes
3. Any additional info that may be needed

Completing a translation

Instructions for completing a translation can be found here.