Skip to content

Commit 1d16d8f

Browse files
committed
Small tidy ups and raise visibility of GitHub PR process
1 parent 5ac2e5f commit 1d16d8f

File tree

1 file changed

+31
-30
lines changed

1 file changed

+31
-30
lines changed

README.SUBMITTING_PATCH

+31-30
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ This document describes how to submit an enhancement or patch for PHP.
55
It's easy!
66

77
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
99
documentation. Once you've followed this README and had several
1010
patches accepted, commit privileges are often quickly granted.
1111

@@ -16,8 +16,8 @@ http://phpadvent.org/2008/less-whining-more-coding-by-elizabeth-smith
1616
Online Forums
1717
-------------
1818
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.
2121

2222

2323
PHP Patches
@@ -33,34 +33,35 @@ and discuss it on the development mail list internals@lists.php.net.
3333
RFC Wiki accounts can be requested on
3434
http://wiki.php.net/start?do=register. PHP extension maintainers can
3535
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.
3737

3838
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
4142
printed reference is the book "Extending and Embedding PHP" by Sara
4243
Golemon.
4344

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-
5345
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
5747

5848
Fork the official PHP repository and send a pull request. A
5949
notification will be sent to the pull request mailing list. Sending a
6050
note to PHP Internals list (internals@lists.php.net) may help getting
6151
more feedback and quicker turnaround. You can also add pull requests
6252
to bug reports at http://bugs.php.net/.
6353

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+
6465

6566
PHP Documentation Patches
6667
-------------------------
@@ -71,7 +72,7 @@ the PHP mail archives.
7172

7273
If your change is large, then first discuss it with the mail list
7374
phpdoc@lists.php.net. Subscription is explained on
74-
http://www.php.net/mailing-lists.php.
75+
http://php.net/mailing-lists.php.
7576

7677
Information on contributing to PHP documentation is at
7778
http://php.net/dochowto and http://wiki.php.net/doc/howto
@@ -89,7 +90,7 @@ of type 'text/*' are accepted.
8990
PECL Extension Patches: http://pecl.php.net/
9091
--------------------------------------------
9192
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
9394
can be used to track the patch progress and prevent your changes
9495
getting lost in the PHP mail archives.
9596

@@ -125,15 +126,15 @@ http://pear.php.net/manual/en/guide-developers.php
125126

126127
How to create your PHP, PHP Documentation or PECL patch
127128
-------------------------------------------------------
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.
133134

134135
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".
137138

138139
Read CODING_STANDARDS before you start working.
139140

@@ -145,15 +146,15 @@ comprehensive.
145146

146147
After testing is finished, create a patch file using the command:
147148

148-
svn diff > your_patch.txt
149+
git diff > your_patch.txt
149150

150151
For ease of review and later troubleshooting, submit individual
151152
patches for each bug or feature.
152153

153154

154155
Checklist for submitting your PHP or PECL code patch
155156
----------------------------------------------------
156-
- Update SVN source just before running your final 'diff' and
157+
- Update git source just before running your final 'diff' and
157158
before testing.
158159
- Add in-line comments and/or have external documentation ready.
159160
Use only "/* */" style comments, not "//".
@@ -186,7 +187,7 @@ about these questions:
186187

187188
What happens when your PHP or PECL patch is applied
188189
---------------------------------------------------
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
190191
patch affects end users, a brief description and your name might be
191192
added to the NEWS file.
192193

0 commit comments

Comments
 (0)