Contributing

Code

Pull requests are welcome! Is there a feature you would like to see, or a bug thats been bothering you? Feel free to dig in. Not sure where to start? Ask on github, use an existing ticket or create a new one.

If you're planning to make a lot of changes please create an issue to discuss implementation details. A lot of effort has gone into the current design so we want to make sure everything will to work together.

Documentation

If you find any errors in the documentation or if there are missing pages, you are welcome to contribute! It is written using MkDocs and Markdown. Follow these instructions to get started:

Now, make your changes and see them live updating in your web browser. Create a pull request in github and we will review and add your changes.

Translations

We are currently using POEditor to manage localization. If you would like to help please consider signing up to contribute through this service.

To join the project sign up here: https://poeditor.com/join/project/2J2hB5I41Z

Adding a new language

You can add a new language from POEditor and start translating.

If you want to stop here, create a ticket on GitHub and someone will update the project. To finish the job completely you'll need to know how to use git.

Future language syncs will be done periodically with the update_languages.py script.