Skip to content

Commit

Permalink
some typo fixing, and following The Little Book, omitting needless words
Browse files Browse the repository at this point in the history
  • Loading branch information
Sascha Schumann committed Mar 19, 2002
1 parent 27bf1db commit 0459ad7
Showing 1 changed file with 27 additions and 20 deletions.
47 changes: 27 additions & 20 deletions README.SUBMITTING_PATCH
Original file line number Original file line Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@ Submitting Patch for PHP


This document describes how to submit a patch for PHP. Since you are This document describes how to submit a patch for PHP. Since you are
reading this document, you are willing to submit a patch for PHP. reading this document, you are willing to submit a patch for PHP.
Please keep reading! Submitting a patch for PHP is easy. Please keep reading! Submitting a patch for PHP is easy. The hard
part is making it acceptable for inclusion into our repository. :-)


How to create patch? How to create patch?
-------------------- --------------------
Expand Down Expand Up @@ -32,6 +33,8 @@ Tips for creating patch
----------------------- -----------------------
If you would like to fix multiple bugs. It is easier for us if you If you would like to fix multiple bugs. It is easier for us if you
could create 1 patch for 1 bug, but this is not strictly required. could create 1 patch for 1 bug, but this is not strictly required.
Note though that you might get little response, if your patch is
too hard to review.


If you would like change/add many lines, it is better to ask module If you would like change/add many lines, it is better to ask module
maintainer and/or php-dev@lists.php.net, or pear-dev@lists.php.net if maintainer and/or php-dev@lists.php.net, or pear-dev@lists.php.net if
Expand Down Expand Up @@ -83,34 +86,38 @@ If you are patching a module, you should also send the patch to the
maintainer. Official module maintainers are listed in EXTENSION file maintainer. Official module maintainers are listed in EXTENSION file
in source. in source.


If you are pachting PEAR, send the patch to pear-dev@lists.php.net. If you are patching PEAR, send the patch to pear-dev@lists.php.net.


Make sure you add "[PATCH]" prefix to mail subject. Please make sure Please add the prefix "[PATCH]" to your email subject and make sure
attach the patch file even if the patch is really short one. If you to include the patch as a MIME attachment even if it is short.
create a test script for your patch, attach it to the same mail. Test scripts should be included in the same email.
Finally, explain what has been fixed/added/changed by your patch. Explain what has been fixed/added/changed by your patch.


If you know bug ID that can be closed by your patch, please note the Finally, add the bug Id(s) which can be closed by your patch, if any.
bug ID number also.




How long it will take to get response? What happens after you submit your patch
-------------------------------------- --------------------------------------
Since we are volunteers, it may take more than a few days to get If your patch is easy to review and has obviously no side-effects,
response. If you didn't get any response in a few days, please let us it might take up to a few hours until someone commits it.
know you have been submitted the patch, but you didn't get any
response. Because this is a volunteer-driven effort, more complex patches will
require more patience on your side.

If you did not receive any feedback in a few days, please consider
resubmitting the description of your patch, along-side with
these questions:

- Is my patch too hard to review? Because of which factors?
- Should I split it up in multiple parts?
- Are there any unwanted whitespace changes?




What happens when your patch is applied? What happens when your patch is applied?
---------------------------------------- ----------------------------------------
When your patch is applied, it will be noted that the patch is Your name will be included together with your email address in the CVS
submitted by you. You may see your email address in ChangeLog file. If commit log. If your patch affects end-users, a brief description
your patch is important to be noted in NEWS file, your patch and your name might be added to the NEWS file.
description and email address will be noted.

If you would not like to be noted in ChangeLog and NEWS file, please
let us know when you submit your patch.




Thank you for submitting patch for PHP! Thank you for submitting patch for PHP!

0 comments on commit 0459ad7

Please sign in to comment.