Skip to content

Latest commit

 

History

History
34 lines (22 loc) · 1.25 KB

CONTRIBUTING.md

File metadata and controls

34 lines (22 loc) · 1.25 KB

How to contribute?

We welcome and encourage every bug report, feature and pull request.

You have an issue with phonemizer or a feature request

Please open an issue on github and follow the template from there.

You want to contribute code

If you're willing to take it upon yourself to improve phonemizer, via bugfixes, improvements and new features, please follow these steps:

  • Submit an issue explaining what you're willing to fix or add to this package. We can discuss with you on the the best way to do it, considering the current state of things.

  • Fork the phonemizer repo, code away and open a pull-request. If you add some code or change significantly a function, please test it by adding more unit tests.

  • Ensure the tests are passing on Linux, MacOS and Windows on the github continuous integration page. This is important because phonemizer is used on a wide range of systems and configurations.

  • Please conform to the following conventions: