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

Changes from 1 commit
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
Prev Previous commit
[#2150] Tweaks per comments from @fabpot and @wouterj
  • Loading branch information
@weaverryan
weaverryan committed Jan 18, 2013
commit 3d45abfff3d87d1b2fffdf15b30b8ae632b9aacd
12 changes: 6 additions & 6 deletions contributing/documentation/overview.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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

Expand Down