Skip to content

Commit

Permalink
Merge branch '2.1'
Browse files Browse the repository at this point in the history
  • Loading branch information
weaverryan committed Jan 18, 2013
2 parents 2fb8acf + 6ac450b commit 5e53d4c
Show file tree
Hide file tree
Showing 7 changed files with 50 additions and 13 deletions.
4 changes: 3 additions & 1 deletion CONTRIBUTING.md
Expand Up @@ -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!
2 changes: 1 addition & 1 deletion components/event_dispatcher/container_aware_dispatcher.rst
Expand Up @@ -74,7 +74,7 @@ The ``EventSubscriberInterface`` will be exactly as you would expect::

class StoreSubscriber implements EventSubscriberInterface
{
static public function getSubscribedEvents()
public static function getSubscribedEvents()
{
return array(
'kernel.response' => array(
Expand Down
2 changes: 1 addition & 1 deletion components/event_dispatcher/introduction.rst
Expand Up @@ -339,7 +339,7 @@ subscribes to the ``kernel.response`` and ``store.order`` events::

class StoreSubscriber implements EventSubscriberInterface
{
static public function getSubscribedEvents()
public static function getSubscribedEvents()
{
return array(
'kernel.response' => array(
Expand Down
12 changes: 7 additions & 5 deletions contributing/code/patches.rst
Expand Up @@ -264,9 +264,10 @@ pull request message, like in:
[Yaml] fixed something
[Form] [Validator] [FrameworkBundle] added something
The pull request description must include the following check list to ensure
that contributions may be reviewed without needless feedback loops and that
your contributions can be included into Symfony2 as quickly as possible:
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:

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

.. code-block:: text
Expand Down
1 change: 1 addition & 0 deletions contributing/code/security.rst
Expand Up @@ -54,6 +54,7 @@ Security Advisories
This section indexes security vulnerabilities that were fixed in Symfony
releases, starting from Symfony 1.0.0:

* January 17, 2013: `Security release: Symfony 2.0.22 and 2.1.7 released <http://symfony.com/blog/security-release-symfony-2-0-22-and-2-1-7-released>`_ (`CVE-2013-1348 <http://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2013-1348>`_ and `CVE-2013-1397 <http://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2013-1397>`_)
* December 20, 2012: `Security release: Symfony 2.0.20 and 2.1.5 <http://symfony.com/blog/security-release-symfony-2-0-20-and-2-1-5-released>`_ (`CVE-2012-6431 <http://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2012-6431>`_ and `CVE-2012-6432 <http://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2012-6432>`_)
* November 29, 2012: `Security release: Symfony 2.0.19 and 2.1.4 <http://symfony.com/blog/security-release-symfony-2-0-19-and-2-1-4>`_
* November 25, 2012: `Security release: symfony 1.4.20 released <http://symfony.com/blog/security-release-symfony-1-4-20-released>`_ (`CVE-2012-5574 <http://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2012-5574>`_)
Expand Down
40 changes: 36 additions & 4 deletions contributing/documentation/overview.rst
Expand Up @@ -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, 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
Expand All @@ -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.

Expand All @@ -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 <license>`.

Pull Request Format
~~~~~~~~~~~~~~~~~~~

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
| Q | A
| ------------- | ---
| Doc fix? | [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]
An example submission could now look as follows:

.. code-block:: text
| Q | A
| ------------- | ---
| Doc fix? | yes
| New docs? | yes (symfony/symfony#2500)
| 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
Expand Down
2 changes: 1 addition & 1 deletion reference/constraints/Callback.rst
Expand Up @@ -186,7 +186,7 @@ process. Each method can be one of the following formats:
class MyStaticValidatorClass
{
static public function isAuthorValid(Author $author, ExecutionContext $context)
public static function isAuthorValid(Author $author, ExecutionContext $context)
{
// ...
}
Expand Down

0 comments on commit 5e53d4c

Please sign in to comment.