summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--CONTRIBUTING.md61
1 files changed, 61 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000000..025db5d5c2
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,61 @@
+# Contributing to PHP
+
+Anybody who programs in PHP can be a contributing member of the community that
+develops and deploys it; the task of deploying PHP, documentation and
+associated websites is a never ending one. With every release, or release
+candidate comes a wave of work, which takes a lot of organization and
+co-ordination.
+
+## Pull requests
+
+PHP welcomes pull requests to [add tests](#writing-tests), fix bugs and to
+implement RFCs. Please be sure to include tests as appropriate!
+
+If you are fixing a bug, then please submit your PR against the lowest branch
+of PHP that the bug affects, or the oldest fully supported version (the first
+green branch on
+[the supported version page](http://php.net/supported-versions.php). For
+example, at the time of writing in mid-2015, this is PHP 5.5, which corresponds
+to the `PHP-5.5` branch in Git. Please also make sure you add a link to the PR
+in the bug on [the bug tracker](https://bugs.php.net/).
+
+Pull requests to implement RFCs should be submitted against `master`.
+
+## Filing bugs
+
+Bugs can be filed on the [PHP bug tracker](https://bugs.php.net/). If this is
+the first time you've filed a bug, we suggest reading the
+[guide to reporting a bug](https://bugs.php.net/how-to-report.php).
+
+Where possible, please include a self-contained reproduction case!
+
+## Feature requests
+
+Feature requests are generally submitted in the form of
+[Requests for Comment](https://wiki.php.net/rfc/howto), ideally accompanied by
+[pull requests](#pull-requests). You can find the extremely large list of RFCs
+that have been previously considered on the
+[PHP Wiki](https://wiki.php.net/rfc).
+
+You may want to read
+[The Mysterious PHP RFC Process](https://blogs.oracle.com/opal/entry/the_mysterious_php_rfc_process)
+for additional notes on the best way to approach submitting an RFC.
+
+## Writing tests
+
+We love getting new tests! PHP is a huge project and improving code coverage is
+a huge win for every PHP user.
+
+[Our QA site includes a page detailing how to write test cases.](http://qa.php.net/write-test.php)
+Please note that the section on submitting pull requests is outdated: in
+addition to the process listed there, you can also
+[submit pull requests](#pull-requests).
+
+## Getting help
+
+If you are having trouble contributing to PHP, or just want to talk to a human
+about what you're working on, you can contact us via the
+[internals mailing list](mailto:internals@lists.php.net).
+
+Although not a formal channel, you can also find a number of core developers on
+the #php.pecl channel on [EFnet](http://www.efnet.org/).