com php-src: Merge branch 'PHP-7.4': CONTRIBUTING.md
| From: | Peter Kokot | Date: | Mon, 25 Mar 2019 22:00:50 +0000 |
| Subject: | com php-src: Merge branch 'PHP-7.4': CONTRIBUTING.md | ||
| Groups: | php.cvs | ||
| Request: | Send a blank email to php-cvs+get-105343@lists.php.net to get a copy of this message | ||
Commit: d0e472740ae15aad1446c33b10ecef96a0eddf10
Author: Peter Kokot <peterkokot@gmail.com> Mon, 25 Mar 2019 23:00:50 +0100
Parents: 5e8116c579e393328dc475ac9c8327af39180457 886b2a22e98ae96497a27d581795debaf6407c5c
Branches: master
Link: http://git.php.net/?p=php-src.git;a=commitdiff;h=d0e472740ae15aad1446c33b10ecef96a0eddf10
Log:
Merge branch 'PHP-7.4'
* PHP-7.4:
[ci skip] Join contributing and patches docs
Changed paths:
MM CONTRIBUTING.md
Diff:
diff --cc CONTRIBUTING.md
index c06ffd0,4459e53..1e4aa9b
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@@ -173,3 -213,68 +213,68 @@@ locations
└─ ...
└─ ...
```
+
+ ## PHP internals
+
+ For information on PHP internal C functions see
+ [References about Maintaining and Extending PHP](https://wiki.php.net/internals/references).
+ Various external resources can be found on the web. A standard printed reference
+ is the book "Extending and Embedding PHP" by Sara Golemon.
+
+ ## PECL extensions
+
+ If you are fixing broken functionality in a [PECL](https://pecl.php.net)
+ extension then create a bug or identify an existing bug at
+ [bugs.php.net](https://bugs.php.net). A bug can be used to track the change
+ progress and prevent your changes getting lost in the PHP mail archives. Some
+ PECL extensions have their own bug tracker locations and different contributing
+ procedures.
+
+ If your change is large then create a
+ [Request for Comments (RFC)](https://wiki.php.net/rfc), discuss it with the
+ extension maintainer, and discuss it on the development mailing list
+ pecl-dev@lists.php.net depending on the extension. PECL mailing list
+ subscription is explained on the
+ [PECL support page](https://pecl.php.net/support.php).
+
+ Update any open bugs and add a link to the source of your change. Send the patch
+ or pointer to the bug to pecl-dev@lists.php.net. Also CC the extension
+ maintainer. Explain what has been changed by your patch. Test scripts should be
+ included.
+
+ ## Checklist for submitting contribution
+
+ - Read [CODING_STANDARDS](/CODING_STANDARDS) before you start working.
+ - Update git source just before running your final
diff and before testing.
+ - Add in-line comments and/or have external documentation ready. Use only
+ /* */ style comments, not //.
+ - Create test scripts for use with make test.
+ - Run make test to check your change doesn't break other features.
+ - Rebuild PHP with --enable-debug which will show some kinds of memory errors
+ and check the PHP and web server error logs after running your PHP tests.
-- Rebuild PHP with --enable-maintainer-zts to check your change compiles on
- multi-threaded web servers.
++- Rebuild PHP with --enable-zts to check your change compiles and operates
++ correctly in a thread safe PHP.
+ - Review the change once more just before submitting it.
+
+ ## What happens after submitting contribution?
+
+ If your change is easy to review and obviously has no side-effects, it might be
+ committed relatively quickly.
+
+ Because PHP is a volunteer-driven effort more complex changes will require
+ patience on your side. If you do not receive feedback in a few days, consider
+ bumping. Before doing this think about these questions:
+
+ - Did I send the patch to the right mailing list?
+ - Did I review the mailing list archives to see if these kind of changes had
+ been discussed before?
+ - Did I explain my change clearly?
+ - Is my change too hard to review? Because of what factors?
+
+ ## What happens when your contribution is applied?
+
+ Your name will likely be included in the Git commit log. If your change affects
+ end users, a brief description and your name might be added to the [NEWS](/NEWS)
+ file..
+
+ Thank you for contributing to PHP!