From a8c7753344b4e2b3be4cda5fd26e2450f95fc53e Mon Sep 17 00:00:00 2001 From: Michele Locati Date: Thu, 12 Apr 2018 11:58:21 +0200 Subject: [PATCH] Add contributor instructions to README.md --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index b926fa7..5c3ff26 100644 --- a/README.md +++ b/README.md @@ -115,3 +115,15 @@ Some extension has special requirements: |:---:|:---:| | pthreads | Requires images with PHP compiled with thread-safety enabled (`zts`). | + + +## How to contribute + +- If you want to add support for a new PHP extension: + 1. change the `install-php-extensions` script + 2. update the `data/supported-extensions` file, adding a new line with the handle of the extension and the list of supported PHP versions + 3. if the extension requires ZTS images: + add a new line to the `data/special-requirements` file, with the extension handle followed by a space and `zts` +- If you want to change the list of supported PHP versions for an already supported extension: + 1. change the `install-php-extensions` script + 2. update the `data/supported-extensions` file, adding the new PHP version to the existing line corresponding to the updated extension