From 89a35bc93adb067c376d7f6c5b4105ca84219a82 Mon Sep 17 00:00:00 2001 From: Ryan Weaver Date: Thu, 17 Jan 2013 05:47:25 -0500 Subject: [PATCH 1/3] Adding an official format to be used for documentation pull requests - this follows closely with the new format introduced for the symfony core repository --- CONTRIBUTING.md | 4 ++- contributing/code/patches.rst | 2 +- contributing/documentation/overview.rst | 40 ++++++++++++++++++++++--- 3 files changed, 40 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index cd6194fe5e3..278f7c2c39c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,4 +2,6 @@ Contributing ------------ We love contributors! For more information on how you can contribute to the -Symfony documentation, please read [Contributing to the Documentation](http://symfony.com/doc/current/contributing/documentation/overview.html) +Symfony documentation, please read [Contributing to the Documentation](http://symfony.com/doc/current/contributing/documentation/overview.html) +and notice the [Pull Request Format](http://symfony.com/doc/current/contributing/documentation/overview.html#pull-request-format) +that helps us merge your pull requests faster! diff --git a/contributing/code/patches.rst b/contributing/code/patches.rst index 581c77a461b..898ac268a99 100644 --- a/contributing/code/patches.rst +++ b/contributing/code/patches.rst @@ -264,7 +264,7 @@ pull request message, like in: [Yaml] fixed something [Form] [Validator] [FrameworkBundle] added something -The pull request description must include the following check list at the top +The pull request description must include the following checklist at the top to ensure that contributions may be reviewed without needless feedback loops and that your contributions can be included into Symfony2 as quickly as possible: diff --git a/contributing/documentation/overview.rst b/contributing/documentation/overview.rst index 87dd52c82f9..75b60e68734 100644 --- a/contributing/documentation/overview.rst +++ b/contributing/documentation/overview.rst @@ -46,8 +46,12 @@ Next, create a dedicated branch for your changes (for organization): You can now make your changes directly to this branch and commit them. When you're done, push this branch to *your* GitHub fork and initiate a pull request. -The pull request will be between your ``improving_foo_and_bar`` branch and -the ``symfony-docs`` ``master`` branch. + +Creating a Pull Request +~~~~~~~~~~~~~~~~~~~~~~~ + +Following the example, create a pull request will be between your ``improving_foo_and_bar`` +branch and the ``symfony-docs`` ``master`` branch. .. image:: /images/docs-pull-request.png :align: center @@ -60,8 +64,8 @@ the base branch to be 2.0 on the preview page: .. note:: - All changes made to the 2.0 branch will be merged into 2.1 which in turn will be - merged into the master branch for the next release on a weekly basis. + All changes made to a branch (e.g. 2.0) will be merged up to each "newer" + branch (e.g. 2.1, master, etc) for the next release on a weekly basis. GitHub covers the topic of `pull requests`_ in detail. @@ -70,6 +74,34 @@ GitHub covers the topic of `pull requests`_ in detail. The Symfony2 documentation is licensed under a Creative Commons Attribution-Share Alike 3.0 Unported :doc:`License `. +Pull Request Format +~~~~~~~~~~~~~~~~~~~ + +To ease the core team's work, the pull request description must include the +following checklist to ensure that contributions may be reviewed without +needless feedback loops and that your contributions can be included into +the documentation as quickly as possible: + +.. code-block:: text + + | Q | A + | ------------- | --- + | Doc fix? | [yes|no] + | New docs? | [yes|no] + | Applies to | [Symfony version numbers this applies to] + | Fixed tickets | [comma separated list of tickets fixed by the PR] + +An example submission could now look as follows: + +.. code-block:: text + + | Q | A + | ------------- | --- + | Doc fix? | yes + | New docs? | no + | Applies to | all (or 2.1+) + | Fixed tickets | #1075 + .. tip:: Please be patient. It can take from 15 minutes to several days for your changes From 8722d9574b2e393ff663c31e150f07cd2f9dd047 Mon Sep 17 00:00:00 2001 From: Ryan Weaver Date: Thu, 17 Jan 2013 07:45:42 -0500 Subject: [PATCH 2/3] Adding note to contributing docs so we can track the related code PR if applicable --- contributing/documentation/overview.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/contributing/documentation/overview.rst b/contributing/documentation/overview.rst index 75b60e68734..0681fc107c0 100644 --- a/contributing/documentation/overview.rst +++ b/contributing/documentation/overview.rst @@ -87,7 +87,7 @@ the documentation as quickly as possible: | Q | A | ------------- | --- | Doc fix? | [yes|no] - | New docs? | [yes|no] + | New docs? | [yes|no] (PR # on symfony/symfony if applicable) | Applies to | [Symfony version numbers this applies to] | Fixed tickets | [comma separated list of tickets fixed by the PR] @@ -98,7 +98,7 @@ An example submission could now look as follows: | Q | A | ------------- | --- | Doc fix? | yes - | New docs? | no + | New docs? | yes (symfony/symfony#2500) | Applies to | all (or 2.1+) | Fixed tickets | #1075 From 3d45abfff3d87d1b2fffdf15b30b8ae632b9aacd Mon Sep 17 00:00:00 2001 From: Ryan Weaver Date: Fri, 18 Jan 2013 07:40:13 -0600 Subject: [PATCH 3/3] [#2150] Tweaks per comments from @fabpot and @WouterJ --- contributing/documentation/overview.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/contributing/documentation/overview.rst b/contributing/documentation/overview.rst index 0681fc107c0..d4ea9beeb6d 100644 --- a/contributing/documentation/overview.rst +++ b/contributing/documentation/overview.rst @@ -50,8 +50,8 @@ you're done, push this branch to *your* GitHub fork and initiate a pull request. Creating a Pull Request ~~~~~~~~~~~~~~~~~~~~~~~ -Following the example, create a pull request will be between your ``improving_foo_and_bar`` -branch and the ``symfony-docs`` ``master`` branch. +Following the example, the pull request will default to be between your +``improving_foo_and_bar`` branch and the ``symfony-docs`` ``master`` branch. .. image:: /images/docs-pull-request.png :align: center @@ -77,10 +77,10 @@ GitHub covers the topic of `pull requests`_ in detail. Pull Request Format ~~~~~~~~~~~~~~~~~~~ -To ease the core team's work, the pull request description must include the -following checklist to ensure that contributions may be reviewed without -needless feedback loops and that your contributions can be included into -the documentation as quickly as possible: +Unless you're fixing some minor typos, the pull request description must** +include the following checklist to ensure that contributions may be reviewed +without needless feedback loops and that your contributions can be included +into the documentation as quickly as possible: .. code-block:: text