@@ -5,7 +5,7 @@ This document describes how to submit an enhancement or patch for PHP.
5
5
It's easy!
6
6
7
7
You don't need any login accounts or special access to download,
8
- build, debug and begin submitting PHP, PECL or PEAR code, tests or
8
+ build, debug and begin submitting PHP or PECL code, tests or
9
9
documentation. Once you've followed this README and had several
10
10
patches accepted, commit privileges are often quickly granted.
11
11
@@ -16,8 +16,8 @@ http://phpadvent.org/2008/less-whining-more-coding-by-elizabeth-smith
16
16
Online Forums
17
17
-------------
18
18
There are several IRC channels where PHP developers are often
19
- available to discuss questions. They include #php.pecl, #php.doc and
20
- #pear on the EFNet network and #php -dev-win on FreeNode.
19
+ available to discuss questions. They include #php.pecl and #php.doc
20
+ on the EFNet network and #winphp -dev on FreeNode.
21
21
22
22
23
23
PHP Patches
@@ -33,34 +33,35 @@ and discuss it on the development mail list internals@lists.php.net.
33
33
RFC Wiki accounts can be requested on
34
34
http://wiki.php.net/start?do=register. PHP extension maintainers can
35
35
be found in the EXTENSIONS file in the PHP source. Mail list
36
- subscription is explained on http://www. php.net/mailing-lists.php.
36
+ subscription is explained on http://php.net/mailing-lists.php.
37
37
38
38
Information on PHP internal C functions is at
39
- http://www.php.net/internals, though this is considered incomplete.
40
- Various external resources can be found on the web. A standard
39
+ http://php.net/internals, though this is considered incomplete.
40
+ Various external resources can be found on the web. See
41
+ https://wiki.php.net/internals for some references. A standard
41
42
printed reference is the book "Extending and Embedding PHP" by Sara
42
43
Golemon.
43
44
44
- Attach the patch to the PHP bug and consider sending a notification
45
- email about the change to internals@lists.php.net. Also CC the
46
- extension maintainer. Explain what has been changed by your patch.
47
- Test scripts should be included.
48
-
49
- Please make the mail subject prefix "[PATCH]". If attaching a patch,
50
- ensure it has a file extension of ".txt". This is because only MIME
51
- attachments of type 'text/*' are accepted.
52
-
53
45
The preferred way to propose PHP patch is sending pull request from
54
- github.
55
-
56
- https://github.com/php/php-src
46
+ GitHub: https://github.com/php/php-src
57
47
58
48
Fork the official PHP repository and send a pull request. A
59
49
notification will be sent to the pull request mailing list. Sending a
60
50
note to PHP Internals list (internals@lists.php.net) may help getting
61
51
more feedback and quicker turnaround. You can also add pull requests
62
52
to bug reports at http://bugs.php.net/.
63
53
54
+ If you are not using GitHub, attach your patch to a PHP bug and
55
+ consider sending a notification email about the change to
56
+ internals@lists.php.net. If the bug is for an extension, also CC the
57
+ extension maintainer. Explain what has been changed by your patch.
58
+ Test scripts should be included.
59
+
60
+ Please make the mail subject prefix "[PATCH]". If attaching a patch,
61
+ ensure it has a file extension of ".txt". This is because only MIME
62
+ attachments of type 'text/*' are accepted.
63
+
64
+
64
65
65
66
PHP Documentation Patches
66
67
-------------------------
@@ -71,7 +72,7 @@ the PHP mail archives.
71
72
72
73
If your change is large, then first discuss it with the mail list
73
74
phpdoc@lists.php.net. Subscription is explained on
74
- http://www. php.net/mailing-lists.php.
75
+ http://php.net/mailing-lists.php.
75
76
76
77
Information on contributing to PHP documentation is at
77
78
http://php.net/dochowto and http://wiki.php.net/doc/howto
@@ -89,7 +90,7 @@ of type 'text/*' are accepted.
89
90
PECL Extension Patches: http://pecl.php.net/
90
91
--------------------------------------------
91
92
If you are fixing broken functionality in a PECL extension then create
92
- a bug or identify an existing bug at http://pecl .php.net/bugs /. A bug
93
+ a bug or identify an existing bug at http://bugs .php.net/. A bug
93
94
can be used to track the patch progress and prevent your changes
94
95
getting lost in the PHP mail archives.
95
96
@@ -125,15 +126,15 @@ http://pear.php.net/manual/en/guide-developers.php
125
126
126
127
How to create your PHP, PHP Documentation or PECL patch
127
128
-------------------------------------------------------
128
- PHP and PECL use Subversion (SVN) for revision control. Read
129
- http://www.php.net/svn .php for help on using SVN to get and build PHP
130
- source code. We recommend using a Sparse Directory checkout described
131
- in http ://wiki.php.net/vcs/svnfaq. If you are new to SVN, read
132
- http ://svnbook.red-bean.com .
129
+ PHP and most PECL packages use Git for revision control. Some PECL
130
+ packages use Subversion (SVN) Read http://www.php.net/git .php for help
131
+ on using Git to get and build PHP source code. We recommend to look
132
+ at our workflow on https ://wiki.php.net/vcs/gitworkflow and our FAQ
133
+ https ://wiki.php.net/vcs/gitfaq .
133
134
134
135
Generally we ask that bug fix patches work on the current stable PHP
135
- development branches and on "trunk ". New PHP features only need to
136
- work on "trunk ".
136
+ development branches and on "master ". New PHP features only need to
137
+ work on "master ".
137
138
138
139
Read CODING_STANDARDS before you start working.
139
140
@@ -145,15 +146,15 @@ comprehensive.
145
146
146
147
After testing is finished, create a patch file using the command:
147
148
148
- svn diff > your_patch.txt
149
+ git diff > your_patch.txt
149
150
150
151
For ease of review and later troubleshooting, submit individual
151
152
patches for each bug or feature.
152
153
153
154
154
155
Checklist for submitting your PHP or PECL code patch
155
156
----------------------------------------------------
156
- - Update SVN source just before running your final 'diff' and
157
+ - Update git source just before running your final 'diff' and
157
158
before testing.
158
159
- Add in-line comments and/or have external documentation ready.
159
160
Use only "/* */" style comments, not "//".
@@ -186,7 +187,7 @@ about these questions:
186
187
187
188
What happens when your PHP or PECL patch is applied
188
189
---------------------------------------------------
189
- Your name will likely be included in the SVN commit log. If your
190
+ Your name will likely be included in the Git commit log. If your
190
191
patch affects end users, a brief description and your name might be
191
192
added to the NEWS file.
192
193
0 commit comments