Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 106 lines (78 sloc) 4.04 kb
69d6f1e3 » Yasuo Ohgaki
2002-03-19 Added README.SUBMITTING_PATCH file. Please fix/add/change.
1 Submitting Patch for PHP
2 ========================
3
4 This document describes how to submit a patch for PHP. Since you are
5 reading this document, you are willing to submit a patch for PHP.
0459ad70 » Sascha Schumann
2002-03-19 some typo fixing, and following The Little Book, omitting needless words
6 Please keep reading! Submitting a patch for PHP is easy. The hard
7 part is making it acceptable for inclusion into our repository. :-)
69d6f1e3 » Yasuo Ohgaki
2002-03-19 Added README.SUBMITTING_PATCH file. Please fix/add/change.
8
9 How to create patch?
10 --------------------
7a2141e4 » rlerdorf
2009-07-13 cvs->svn
11 We use Subversion (SVN) for revision control. You need to get the
12 source from SVN in order to create a patch. Read
13 http://www.php.net/svn.php for help on using SVN. You can check out
14 older branches, but make sure you get trunk as well and make your
15 patch work there.
69d6f1e3 » Yasuo Ohgaki
2002-03-19 Added README.SUBMITTING_PATCH file. Please fix/add/change.
16
17 Read CODING_STANDARDS file before you start working.
18
19 Now you are ready to create a patch. Modify source to fix a bug in PHP or
20 add a new feature to PHP. After you finished editing, please test your
21 patch. Read README.TESTING for testing.
22
23 After you finish testing your patch, take diff file using
7a2141e4 » rlerdorf
2009-07-13 cvs->svn
24 "svn diff > your.patch" command.
69d6f1e3 » Yasuo Ohgaki
2002-03-19 Added README.SUBMITTING_PATCH file. Please fix/add/change.
25
26 Read README.TESTING for submitting a test script for your patch. This is
27 not strictly required, but it is preferred to submit a test script along
28 with your patch. Making new test script is very easy. It also helps us
29 to understand what you have been fixed or added to PHP.
30
31
32 Tips for creating patch
33 -----------------------
34 If you would like to fix multiple bugs. It is easier for us if you
35 could create 1 patch for 1 bug, but this is not strictly required.
0459ad70 » Sascha Schumann
2002-03-19 some typo fixing, and following The Little Book, omitting needless words
36 Note though that you might get little response, if your patch is
37 too hard to review.
69d6f1e3 » Yasuo Ohgaki
2002-03-19 Added README.SUBMITTING_PATCH file. Please fix/add/change.
38
39 If you would like change/add many lines, it is better to ask module
dc042665 » Derick Rethans
2003-07-08 - Fixed email address
40 maintainer and/or internals@lists.php.net, or pear-dev@lists.php.net if
69d6f1e3 » Yasuo Ohgaki
2002-03-19 Added README.SUBMITTING_PATCH file. Please fix/add/change.
41 you are patching PEAR. Official module maintainers can be found in
42 EXTENSIONS file in PHP source.
43
7a2141e4 » rlerdorf
2009-07-13 cvs->svn
44 If you are new to SVN (Subversion), visit
45 http://svnbook.red-bean.com/ for details.
69d6f1e3 » Yasuo Ohgaki
2002-03-19 Added README.SUBMITTING_PATCH file. Please fix/add/change.
46
47
48 Check list for submitting patch
49 -------------------------------
50 - Did you run "make test" to check if your patch didn't break
51 other features?
553112ee » jparise
2002-10-23 Capitalize PHP and spell "web server" using two words.
52 - Did you compile PHP with --enable-debug and check the PHP and
53 web server error logs when you test your patch?
69d6f1e3 » Yasuo Ohgaki
2002-03-19 Added README.SUBMITTING_PATCH file. Please fix/add/change.
54 - Did you build PHP for multi-threaded web servers. (Optional)
55 - Did you create test script for "make test"? (Recommended)
7a2141e4 » rlerdorf
2009-07-13 cvs->svn
56 - Did you update SVN source before you take final patch?
69d6f1e3 » Yasuo Ohgaki
2002-03-19 Added README.SUBMITTING_PATCH file. Please fix/add/change.
57 - Did you read the patch again?
58
59
60 Where to send your patch?
61 -------------------------
dc042665 » Derick Rethans
2003-07-08 - Fixed email address
62 If you are patching C source, send the patch to internals@lists.php.net.
69d6f1e3 » Yasuo Ohgaki
2002-03-19 Added README.SUBMITTING_PATCH file. Please fix/add/change.
63 If you are patching a module, you should also send the patch to the
64 maintainer. Official module maintainers are listed in EXTENSION file
65 in source.
66
0459ad70 » Sascha Schumann
2002-03-19 some typo fixing, and following The Little Book, omitting needless words
67 If you are patching PEAR, send the patch to pear-dev@lists.php.net.
69d6f1e3 » Yasuo Ohgaki
2002-03-19 Added README.SUBMITTING_PATCH file. Please fix/add/change.
68
0459ad70 » Sascha Schumann
2002-03-19 some typo fixing, and following The Little Book, omitting needless words
69 Please add the prefix "[PATCH]" to your email subject and make sure
70 to include the patch as a MIME attachment even if it is short.
87e3b970 » Melvyn Sopacua
2002-11-14 Add a note about the mime-type
71
8298f6f9 » Melvyn Sopacua
2002-11-14 typo
72 NOTE: only MIME attachments of type 'text/*' are accepted. The
8a072165 » Marcus Boerger
2003-12-22 Typos found by Petras Kudaras.
73 easiest way to accomplish this, is to make the extension
87e3b970 » Melvyn Sopacua
2002-11-14 Add a note about the mime-type
74 '.txt'.
75
0459ad70 » Sascha Schumann
2002-03-19 some typo fixing, and following The Little Book, omitting needless words
76 Test scripts should be included in the same email.
77 Explain what has been fixed/added/changed by your patch.
69d6f1e3 » Yasuo Ohgaki
2002-03-19 Added README.SUBMITTING_PATCH file. Please fix/add/change.
78
0459ad70 » Sascha Schumann
2002-03-19 some typo fixing, and following The Little Book, omitting needless words
79 Finally, add the bug Id(s) which can be closed by your patch, if any.
69d6f1e3 » Yasuo Ohgaki
2002-03-19 Added README.SUBMITTING_PATCH file. Please fix/add/change.
80
81
0459ad70 » Sascha Schumann
2002-03-19 some typo fixing, and following The Little Book, omitting needless words
82 What happens after you submit your patch
8a072165 » Marcus Boerger
2003-12-22 Typos found by Petras Kudaras.
83 ----------------------------------------
0459ad70 » Sascha Schumann
2002-03-19 some typo fixing, and following The Little Book, omitting needless words
84 If your patch is easy to review and has obviously no side-effects,
85 it might take up to a few hours until someone commits it.
86
87 Because this is a volunteer-driven effort, more complex patches will
88 require more patience on your side.
89
90 If you did not receive any feedback in a few days, please consider
91 resubmitting the description of your patch, along-side with
92 these questions:
93
94 - Is my patch too hard to review? Because of which factors?
95 - Should I split it up in multiple parts?
96 - Are there any unwanted whitespace changes?
69d6f1e3 » Yasuo Ohgaki
2002-03-19 Added README.SUBMITTING_PATCH file. Please fix/add/change.
97
98
99 What happens when your patch is applied?
100 ----------------------------------------
7a2141e4 » rlerdorf
2009-07-13 cvs->svn
101 Your name will be included together with your email address in the SVN
0459ad70 » Sascha Schumann
2002-03-19 some typo fixing, and following The Little Book, omitting needless words
102 commit log. If your patch affects end-users, a brief description
103 and your name might be added to the NEWS file.
69d6f1e3 » Yasuo Ohgaki
2002-03-19 Added README.SUBMITTING_PATCH file. Please fix/add/change.
104
105
106 Thank you for submitting patch for PHP!
Something went wrong with that request. Please try again.