Skip to content

Minor improvements for the contribution guide #7053

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 1 commit into from
Oct 14, 2016
Merged

Minor improvements for the contribution guide #7053

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 9 additions & 7 deletions contributing/documentation/overview.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ this value accordingly):
.. code-block:: terminal

$ cd projects/
$ git clone git://github.com/<YOUR GITHUB USERNAME>/symfony-docs.git
$ git clone git://github.com/YOUR-GITHUB-USERNAME/symfony-docs.git

**Step 3.** Add the original Symfony docs repository as a "Git remote" executing
this command:
Expand All @@ -106,8 +106,8 @@ your project:
.. code-block:: terminal

$ git remote -v
origin [email protected]:<YOUR GITHUB USERNAME>/symfony-docs.git (fetch)
origin [email protected]:<YOUR GITHUB USERNAME>/symfony-docs.git (push)
origin [email protected]:YOUR-GITHUB-USERNAME/symfony-docs.git (fetch)
origin [email protected]:YOUR-GITHUB-USERNAME/symfony-docs.git (push)
upstream https://github.com/symfony/symfony-docs.git (fetch)
upstream https://github.com/symfony/symfony-docs.git (push)

Expand Down Expand Up @@ -158,7 +158,7 @@ forked repository and ``improve_install_chapter`` is the name of the branch you
created previously.

**Step 7.** Everything is now ready to initiate a **pull request**. Go to your
forked repository at ``https//github.com/<YOUR GITHUB USERNAME>/symfony-docs``
forked repository at ``https//github.com/YOUR-GITHUB-USERNAME/symfony-docs``
and click on the **Pull Requests** link located in the sidebar.

Then, click on the big **New pull request** button. As GitHub cannot guess the
Expand Down Expand Up @@ -223,12 +223,14 @@ contribution to the Symfony docs:

# ... do your changes

# add and commit your changes
$ git add xxx.rst # (optional) only if this is a new content
# (optional) add your changes if this is a new content
$ git add xxx.rst

# commit your changes and push them to your fork
$ git commit xxx.rst
$ git push origin my_changes

# go to GitHub and create the Pull Request
# ... go to GitHub and create the Pull Request

# (optional) make the changes requested by reviewers and commit them
$ git commit xxx.rst
Expand Down