Skip to content

Adding an official format to be used for documentation pull requests #2150

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jan 18, 2013
Merged

Adding an official format to be used for documentation pull requests #2150

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
89a35bc
Adding an official format to be used for documentation pull requests …
weaverryan Jan 17, 2013
8722d95
Adding note to contributing docs so we can track the related code PR …
weaverryan Jan 17, 2013
3d45abf
[#2150] Tweaks per comments from @fabpot and @WouterJ
weaverryan Jan 18, 2013
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
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 contributing/code/patches.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
40 changes: 36 additions & 4 deletions contributing/documentation/overview.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
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