So you want to help out with testing, and your next question is, "How do I get started?"
- 1 Sign up to Launchpad (mandatory)
- 2 Sign up to the Developer Mailing List (mandatory)
- 3 Hang out in the IRC channel with us (highly recommended)
- 4 Get your testing environment up and running
- 5 Check out the latest code
- 6 Run OpenLP!
Sign up to Launchpad (mandatory)
If you don't yet have a Launchpad username, you'll need to sign up for one. In order to commit code back into the main branch, you'll need to have a Launchpad username, and will need to apply to be added to the OpenLP Development team on Launchpad. Once you're on Launchpad, you can propose a merge.
Why Bazaar/Why Launchpad
Folks often come into our IRC channel and ask why we chose Bazaar and Launchpad for development. The reality is that Launchpad was launched in January 2004, while Github was only launched in April 2008. At the time that OpenLP moved from SourceForge.net (where it had been since 2004), Launchpad was the only other widely known online source code repository. Since Bazaar's workflow closely resembles that of Subversion, the version control system OpenLP was coming from, it seemed a natural progression. At the time, git was also extremely small and unsupported by most online source code repositories. After two repository moves and three version control moves, OpenLP is going to stay where it is.
Sign up to the Developer Mailing List (mandatory)
The OpenLP development team uses a mailing list for all important communication. To sign up for the mailing list, go to https://lists.openlp.io/mailman/listinfo/openlp-dev
Hang out in the IRC channel with us (highly recommended)
Almost all of the developers are active in the OpenLP IRC channel. We discuss a lot of things in IRC that don't necessarily make it on to the mailing list or the wiki, so it is advantageous to hang out in IRC.
A few notes, with regards to IRC:
- Most of the developers live in timezones close to UTC (GMT), and as such will not be around in the evening hours of the USA.
- Don't private message people, this is regarded as rude
- Don't use CAPITAL LETTERS, this is also regarded as rude
- Multiple exclamations!!! or question marks??? are unnecessary
- IRC is not private, don't post any information you don't want the general public reading
- Use LodgeIt! for code, or anything else you want to paste which is longer than 3 lines
- Relax, we're a friendly bunch and like to joke around. Don't take us too seriously.
The active core developers are superfly, TRB143 and tgc. Some of the other active developers are Azaziah, alisonken1 and thelinuxguy. Unit193 and wrst are often around at times when others aren't, and can usually point you in the right direction.
Most of the developers are in timezones from UTC to UTC+2.
Get your testing environment up and running
There are regular nightly builds which you can use for testing. These are found on the OpenLP download page.
For the more adventurous, you can run OpenLP 2.0 from the source code. You'll need to install Python 3, Qt4, and the PyQt4 Python bindings for Qt4. You'll also need the Bazaar client in order to check out the latest code. Read through more detailed instructions on the Linux, Mac OS X and Windows pages.
Check out the latest code
OpenLP uses the Bazaar DVCS (read more about Bazaar) and the main branch is hosted at Launchpad.net. Do the following to set up your local branch:
- Identify yourself to Bazaar:
$ bzr whoami "Raoul Snyman <email@example.com>"
- Log in to Launchpad:
$ bzr launchpad-login raoul-snyman
- Create a shared repository:
$ bzr init-repo ~/openlp
- Checkout the latest code:
$ bzr checkout lp:openlp ~/openlp/trunk
Finally, you'll want to run OpenLP. Open your command line and navigate to where you checked out OpenLP, and then run the openlp.py file:
Linux/Mac OS X