Merge pull request symfony#725 from lsmith77/patch_check_list

weaverryan · weaverryan · commit 0892a2cf5cb9 · 2011-09-23T09:13:35.000-07:00
[WIP] Patch check list
diff --git a/contributing/code/patches.rst b/contributing/code/patches.rst
@@ -4,6 +4,46 @@ Submitting a Patch
 Patches are the best way to provide a bug fix or to propose enhancements to
 Symfony2.
 
+Check List
+----------
+
+The purpose of the check list is to ensure that contributions may be reviewed
+with needless feedback loops to ensure that your contributions can be included
+into Symfony2 as quickly as possible.
+
+.. warning::
+
+    All pull requests should include the following template in the request
+    description:
+
+.. code-block:: plain
+
+    Bug fix: [yes|no]
+    Feature addition: [yes|no]
+    Backwards compatibility break: [yes|no]
+    Symfony2 tests pass: [yes|no]
+    Fixes the following tickets: [comma separated list of tickets fixed by the PR]
+
+An example submission could now look as follows:
+
+.. code-block:: plain
+
+    Bug fix: no
+    Feature addition: yes
+    Backwards compatibility break: no
+    Symfony2 tests pass: yes
+    Fixes the following tickets: -
+
+Thank you for including the filled out template in your submission!
+
+.. tip::
+
+    All feature addition's should be send to the "master" branch, while all
+    bug fixes should be send to the oldest still active branch. Furthermore
+    submissions should as a rule of thumb not break backwards compatibility.
+    Please mark any submissions as "[WIP]" in the title in case the submission
+    is not yet complete (for example if the tests do not yet pass).
+
 Initial Setup
 -------------
 
