From e92c57d87a3afdb16e5f98af38c718d071142be9 Mon Sep 17 00:00:00 2001 From: Lukas Kahwe Smith Date: Fri, 23 Sep 2011 14:02:29 +0200 Subject: [PATCH 1/3] added a check list for pull request submissions --- contributing/code/patches.rst | 42 +++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) diff --git a/contributing/code/patches.rst b/contributing/code/patches.rst index d95554dd852..dd6b18dcdf3 100644 --- a/contributing/code/patches.rst +++ b/contributing/code/patches.rst @@ -4,6 +4,48 @@ 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] + Description: [description of the change] + +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: - + Description: Add X to Y to make the world a brighter place + +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 never 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 ------------- From ba55af9d2bc54d79fdb38f5a7f01d01a6e435c0f Mon Sep 17 00:00:00 2001 From: Lukas Kahwe Smith Date: Fri, 23 Sep 2011 17:28:28 +0200 Subject: [PATCH 2/3] tweaked text on BC breaks --- contributing/code/patches.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/contributing/code/patches.rst b/contributing/code/patches.rst index dd6b18dcdf3..fa397053233 100644 --- a/contributing/code/patches.rst +++ b/contributing/code/patches.rst @@ -42,8 +42,8 @@ Thank you for including the filled out template in your submission! 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 never break backwards compatibility. Please - mark any submissions as "[WIP]" in the title in case the submission + 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 From 6fd71e02a8fa85c6a71ce3af374356e8319d008b Mon Sep 17 00:00:00 2001 From: Lukas Kahwe Smith Date: Fri, 23 Sep 2011 17:37:01 +0200 Subject: [PATCH 3/3] removed description from the checklist --- contributing/code/patches.rst | 2 -- 1 file changed, 2 deletions(-) diff --git a/contributing/code/patches.rst b/contributing/code/patches.rst index fa397053233..daaa9d8c996 100644 --- a/contributing/code/patches.rst +++ b/contributing/code/patches.rst @@ -23,7 +23,6 @@ into Symfony2 as quickly as possible. Backwards compatibility break: [yes|no] Symfony2 tests pass: [yes|no] Fixes the following tickets: [comma separated list of tickets fixed by the PR] - Description: [description of the change] An example submission could now look as follows: @@ -34,7 +33,6 @@ An example submission could now look as follows: Backwards compatibility break: no Symfony2 tests pass: yes Fixes the following tickets: - - Description: Add X to Y to make the world a brighter place Thank you for including the filled out template in your submission!