Skip to content

Commit

Permalink
[contributing][docs] Adding more detail on how to make contributions …
Browse files Browse the repository at this point in the history
…to the documentation
  • Loading branch information
weaverryan committed Apr 6, 2011
1 parent c213e0c commit 779ca87
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 4 deletions.
28 changes: 24 additions & 4 deletions contributing/documentation/overview.rst
Expand Up @@ -12,17 +12,34 @@ Contributing
Before contributing, you need to become familiar with the :doc:`markup
language <format>` used by the documentation.

The Symfony2 documentation is hosted in a Git repository:
The Symfony2 documentation is hosted on GitHub:

.. code-block:: bash
git://github.com/symfony/symfony-docs.git
https://github.com/symfony/symfony-docs
If you want to submit a patch, clone the official documentation repository:
If you want to submit a patch, `fork`_ the official repository on GitHub and
then clone your fork:

.. code-block:: bash
$ git clone git://github.com/symfony/symfony-docs.git
$ git clone git://github.com/YOURUSERNAME/symfony-docs.git
Next, create a dedicated branch for your changes (for organization):

.. code-block:: bash
$ git checkout -b improving_foo_and_bar
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.

.. image:: /images/docs-pull-request.png
:align: center

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

.. note::

Expand All @@ -45,3 +62,6 @@ Translating
-----------

Read the dedicated :doc:`document <translations>`.

.. _`fork`: http://help.github.com/fork-a-repo/
.. _`pull requests`: http://help.github.com/pull-requests/
Binary file added images/docs-pull-request.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 779ca87

Please sign in to comment.