Skip to content

Commit a758cea

Browse files
committed
Merge branch '2.0' into 2.1
2 parents 92baa85 + 95582d6 commit a758cea

File tree

5 files changed

+48
-12
lines changed

5 files changed

+48
-12
lines changed

CONTRIBUTING.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,6 @@ Contributing
22
------------
33

44
We love contributors! For more information on how you can contribute to the
5-
Symfony documentation, please read [Contributing to the Documentation](http://symfony.com/doc/current/contributing/documentation/overview.html)
5+
Symfony documentation, please read [Contributing to the Documentation](http://symfony.com/doc/current/contributing/documentation/overview.html)
6+
and notice the [Pull Request Format](http://symfony.com/doc/current/contributing/documentation/overview.html#pull-request-format)
7+
that helps us merge your pull requests faster!

components/event_dispatcher/introduction.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -339,7 +339,7 @@ subscribes to the ``kernel.response`` and ``store.order`` events::
339339

340340
class StoreSubscriber implements EventSubscriberInterface
341341
{
342-
static public function getSubscribedEvents()
342+
public static function getSubscribedEvents()
343343
{
344344
return array(
345345
'kernel.response' => array(

contributing/code/patches.rst

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -264,9 +264,10 @@ pull request message, like in:
264264
[Yaml] fixed something
265265
[Form] [Validator] [FrameworkBundle] added something
266266
267-
The pull request description must include the following check list to ensure
268-
that contributions may be reviewed without needless feedback loops and that
269-
your contributions can be included into Symfony2 as quickly as possible:
267+
The pull request description must include the following checklist at the top
268+
to ensure that contributions may be reviewed without needless feedback
269+
loops and that your contributions can be included into Symfony2 as quickly as
270+
possible:
270271

271272
.. code-block:: text
272273
@@ -296,8 +297,9 @@ An example submission could now look as follows:
296297
| License | MIT
297298
| Doc PR | symfony/symfony-docs#123
298299
299-
For typos, minor changes in the PHPDocs, or changes in translation files, use
300-
the shorter version of the check-list:
300+
The whole table must be included (do **not** remove lines that you think are
301+
not relevant). For simple typos, minor changes in the PHPDocs, or changes in
302+
translation files, use the shorter version of the check-list:
301303

302304
.. code-block:: text
303305

contributing/documentation/overview.rst

Lines changed: 36 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,12 @@ Next, create a dedicated branch for your changes (for organization):
4646
4747
You can now make your changes directly to this branch and commit them. When
4848
you're done, push this branch to *your* GitHub fork and initiate a pull request.
49-
The pull request will be between your ``improving_foo_and_bar`` branch and
50-
the ``symfony-docs`` ``master`` branch.
49+
50+
Creating a Pull Request
51+
~~~~~~~~~~~~~~~~~~~~~~~
52+
53+
Following the example, the pull request will default to be between your
54+
``improving_foo_and_bar`` branch and the ``symfony-docs`` ``master`` branch.
5155

5256
.. image:: /images/docs-pull-request.png
5357
:align: center
@@ -60,8 +64,8 @@ the base branch to be 2.0 on the preview page:
6064

6165
.. note::
6266

63-
All changes made to the 2.0 branch will be merged into 2.1 which in turn will be
64-
merged into the master branch for the next release on a weekly basis.
67+
All changes made to a branch (e.g. 2.0) will be merged up to each "newer"
68+
branch (e.g. 2.1, master, etc) for the next release on a weekly basis.
6569

6670
GitHub covers the topic of `pull requests`_ in detail.
6771

@@ -70,6 +74,34 @@ GitHub covers the topic of `pull requests`_ in detail.
7074
The Symfony2 documentation is licensed under a Creative Commons
7175
Attribution-Share Alike 3.0 Unported :doc:`License <license>`.
7276

77+
Pull Request Format
78+
~~~~~~~~~~~~~~~~~~~
79+
80+
Unless you're fixing some minor typos, the pull request description must**
81+
include the following checklist to ensure that contributions may be reviewed
82+
without needless feedback loops and that your contributions can be included
83+
into the documentation as quickly as possible:
84+
85+
.. code-block:: text
86+
87+
| Q | A
88+
| ------------- | ---
89+
| Doc fix? | [yes|no]
90+
| New docs? | [yes|no] (PR # on symfony/symfony if applicable)
91+
| Applies to | [Symfony version numbers this applies to]
92+
| Fixed tickets | [comma separated list of tickets fixed by the PR]
93+
94+
An example submission could now look as follows:
95+
96+
.. code-block:: text
97+
98+
| Q | A
99+
| ------------- | ---
100+
| Doc fix? | yes
101+
| New docs? | yes (symfony/symfony#2500)
102+
| Applies to | all (or 2.1+)
103+
| Fixed tickets | #1075
104+
73105
.. tip::
74106

75107
Please be patient. It can take from 15 minutes to several days for your changes

reference/constraints/Callback.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -186,7 +186,7 @@ process. Each method can be one of the following formats:
186186
187187
class MyStaticValidatorClass
188188
{
189-
static public function isAuthorValid(Author $author, ExecutionContext $context)
189+
public static function isAuthorValid(Author $author, ExecutionContext $context)
190190
{
191191
// ...
192192
}

0 commit comments

Comments
 (0)