Translations of this page:

develop:start

phpList Development

Infrastructure

For the complete list of phpList development links, including repositories, documentation, and more, see the development infrastructure page. See also the development environment setup guide.

From May 2017, you can now use docker to create a working phpList on your local system from source, for development purposes.

Coding Style

phpList uses a few coding standards to keep code uniform and consistent with best practice. Your contributions should adhere to these also.

Function index

phpList includes many custom functions to make adding new features easier. These include functions for getting and setting message data, for example. A comprehensive list with documentation of these functions exists in the Function index.

Contributing

Agreement required

Please sign the Contributor License Agreement (CLA) via GitHub to make managing the legal aspects of the phpList codebase simpler. It is only required once and takes just a few seconds. Alternatively sign and send the CLA to us by email or post.

Automated testing frameworks

phpList uses both Behat and phpUnit for automated testing.

Behat

Guidelines for writing and running user acceptance tests with Behat can be found here:

https://github.com/phpList/phplist3/tree/master/features

phpUnit

phpUnit tests for phpList 4 use a custom configuration documented in the phpList 4 documentation folder.

Writing plugins

phpList includes a powerful plugin framework for extending application functionality. Most aspects of phpList's behaviour can be changed via a broad range of plugin hooks. See the comprehensive guide to writing a plugin. A directory of existing plugins exists on the Plugins page.

Unlike contributions to the phpList core applications, plugins can use a variety of different copyright licenses, so long as they are compatible with the license of phpList.

phpList in Docker

To facilitate development of phpList, core code, themes and plugins, you can now set up phpList in docker and work with your local code.

Virtual Machine

To help setting up a development environment, you can try to get the phpList development virtual machine running.

develop/start.txt · Last modified: 2017/05/21 23:01 by michiel

Resources
Contact Us

e: info@phplist.com

Boring Bit

phpList is a registered limited company

UK Company No. 07582966

VAT Registration 122 0788 37

© phpList 2013