Contributing to phpList
Release Candidates (Beta)
phpList has a rapid Agile release cycle. Every 2 months a new Release Candidate (Beta version) will be released including changes from GitHub and new Translations. From the day an RC is released, usually, a new stable version will be released in 10 days. In case bugs are found in the RC, another RC will be released with a fix. This will continue until we have a stable RC that we can turn into a final, stable release for production.
All the phpList development happens in public repositories on GitHub. If you would like to submit a change:
- create a new branch (try giving the branch a descriptive name)
- make any changes you would like on that new branch
- create a Pull Request asking to merge your branch with Master
- Sign Contributor License Agreement (CLA)
Release Candidates are published on GitHub Releases, SourceForge, and Docker Hub. The RC will be announced at the Discussion community forum for the community to check. Issues are reported at:
- Discussion community forum
- GitHub Issues
Once we have reached a stable RC that has no bug reports, the Final Version will be released for anybody who wants to use phpList in production. You can download a copy of the latest phpList version from:
- the official Download page
- Docker Hub
It is recommended not to use phpList RCs in production servers since issues may arise.
The phpList translations system lives at translate.phplist.org and is a Weblate self-hosted installation. Weblate is an open source, community-driven continuous localization system. We’d like to thank everyone for making this great software available for free and invite you to the Weblate Contributions page!
How to translate phpList
- Express your interest for translating phpList at the community forum. New contributors are able to only Suggest translations and not Save, to ensure that spam users will not add inaccurate terms.
- Someone with admin rights will upgrade your account so you will be able to save your changes.
- Register a new account by clicking the “Register” button in the upper right corner of your screen. You will receive a confirmation email at the provided email address.
- Browse the list of languages that are already there.
- In case your desired language is not listed, at the bottom of the list, you will see a “Start new translation” button where you can select the language you want.
Receive the newly translated strings
The newly translated strings will be committed automatically to the phpList translations repository on GitHub and will be merged prior to every release. To receive the newly translated strings, check for new phpList versions and simply update your languages by clicking “Update Translations” under “System”.
Keep in mind that suggested strings are not included in the next phpList release.
phpList is a software with a 20 year history and over the course of these years many issues and bugs have been discovered by the users. Reporting bugs is one of the most important aspects of building functional but most important secure software.
Reporting a bug responsibly
When disclosing a bug finding, contributors help ensure that phpList performs as it expected to and is secure. In case you discover a security flaw, please make sure to report this responsibly and privately because otherwise thousands of phpList installations get exposed to potential attacks! When disclosing a bug finding, You can report your findings at:
- GitHub repos
- community forum
- direct, private email at email@example.com (please use a descriptive subject)
Write for the Blog
The phpList community blog is the space where phpList or Open Source news in general get published. New