Skip to content

GitLab

wiki
wiki
Last edited by Daniel Martin
Page history

Getting_Started

So you want to help out with the development, and your next question is, "How do I get started?"

Mandatory Requirements

If you are interested in contributing to OpenLP at all, including just bug fixes, these are all mandatory requirements. If you just want to look at the code, it is highly recommended that you join the developers in IRC.

Learn How We Do Things (mandatory)

All open source projects have their own way of doing things, and OpenLP is no different. We have standards around naming conventions, syntax and what text in various parts of the GUI should be like. We also have our own development workflow.

Coding and String Standards

Go and read the Coding Standards and the String Standards. If your code and your strings don't conform to the standards, then your merge proposals will be rejected and you may have to rewrite your code.

Development Workflow

We have our own unique workflow in OpenLP. If you're keen to help out, you'll need to learn our development workflow.

Get your development environment up and running

OpenLP is written in Python 3 and Qt5, so you'll need to install Python 3 (3.5+), Qt5, and the PyQt5 Python bindings for Qt5. PyCharm is a great Python IDE with support for PyQt5 which many of the developers use (there is a community edition available for free). You'll also need a Git client in order to check out the latest code. Read more detailed instructions on the following pages: