You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+22Lines changed: 22 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -4,6 +4,24 @@
4
4
===================================
5
5
Tools to make it easier to contribute to PHP itself ([php-src](https://github.com/php/php-src)). Uses Docker containers for building, running and testing PHP from source.
6
6
7
+
```
8
+
$ composer global require aboks/php-src-devtools
9
+
$ git clone https://github.com/php/php-src.git && cd php-src
10
+
# write a test, or make your own changes to PHP
11
+
$ php-src-devtools test
12
+
```
13
+
14
+
Why?
15
+
----
16
+
Even though there is a thriving open source community for projects written in PHP, only a very limited number of these people contribute to PHP itself. This can partly be explained by the fact that contributing to PHP internals is quite different from contributing to a PHP project: it uses a different language (C instead of PHP), different tools, and another workflow.
17
+
18
+
This project aims to remove some of these barriers for PHP developers to become PHP core developers:
19
+
20
+
* Compiling and testing PHP within a Docker container removes the need to install any build dependencies, which can clutter your system or not be easily available for your OS. In particular, it provides a greatly simplified path to get started for Windows users.
21
+
* Most PHP developers will be used to installing tools like this using Composer.
22
+
* Using tools that PHP developers might be already using (Symfony Console and Docker) provides a familiar experience.
23
+
* The console application abstracts some of the necessary build steps away, and makes the possible actions discoverable.
24
+
7
25
Prerequisites
8
26
-------------
9
27
Ensure that [Docker](https://www.docker.com/get-docker) is installed and running on your system.
@@ -25,6 +43,10 @@ In the folder that contains your clone of php-src, run:
25
43
*`php-src-devtools php` to run the compiled PHP CLI, e.g. `php-src-devtools php -i` for phpinfo.
26
44
*`php-src-devtools list` to see all subcommands, or `php-src-devtools help` for additional help.
27
45
46
+
Status
47
+
------
48
+
This tool is still in a pretty experimental stage, but the basic things like building PHP from source and running tests should work fine. Please try it out and report any issues and possible improvements that you encounter. Pull requests are welcome.
49
+
28
50
Versioning
29
51
----------
30
52
This project adheres to [Semantic Versioning](http://semver.org/).
0 commit comments