Skip to content

Commit 40f27ef

Browse files
committed
minor #7053 Minor improvements for the contribution guide (javiereguiluz)
This PR was merged into the 2.7 branch. Discussion ---------- Minor improvements for the contribution guide Changing `<YOUR GITHUB USERNAME>` to `YOUR-GITHUB-USERNAME` is needed because otherwise our terminal lexer considers it a Windows prompt in some cases: ![wrong_prompt](https://cloud.githubusercontent.com/assets/73419/19231010/eb6d0a94-8ed7-11e6-8961-43c8ecf74777.png) I don't think it's worth it to try to fix this in the lexer. Commits ------- e8e98cc Minor improvements for the contribution guide
2 parents 519a2d0 + e8e98cc commit 40f27ef

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

contributing/documentation/overview.rst

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ this value accordingly):
9090
.. code-block:: terminal
9191
9292
$ cd projects/
93-
$ git clone git://github.com/<YOUR GITHUB USERNAME>/symfony-docs.git
93+
$ git clone git://github.com/YOUR-GITHUB-USERNAME/symfony-docs.git
9494
9595
**Step 3.** Add the original Symfony docs repository as a "Git remote" executing
9696
this command:
@@ -106,8 +106,8 @@ your project:
106106
.. code-block:: terminal
107107
108108
$ git remote -v
109-
origin git@github.com:<YOUR GITHUB USERNAME>/symfony-docs.git (fetch)
110-
origin git@github.com:<YOUR GITHUB USERNAME>/symfony-docs.git (push)
109+
origin git@github.com:YOUR-GITHUB-USERNAME/symfony-docs.git (fetch)
110+
origin git@github.com:YOUR-GITHUB-USERNAME/symfony-docs.git (push)
111111
upstream https://github.com/symfony/symfony-docs.git (fetch)
112112
upstream https://github.com/symfony/symfony-docs.git (push)
113113
@@ -158,7 +158,7 @@ forked repository and ``improve_install_chapter`` is the name of the branch you
158158
created previously.
159159

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

164164
Then, click on the big **New pull request** button. As GitHub cannot guess the
@@ -223,12 +223,14 @@ contribution to the Symfony docs:
223223
224224
# ... do your changes
225225
226-
# add and commit your changes
227-
$ git add xxx.rst # (optional) only if this is a new content
226+
# (optional) add your changes if this is a new content
227+
$ git add xxx.rst
228+
229+
# commit your changes and push them to your fork
228230
$ git commit xxx.rst
229231
$ git push origin my_changes
230232
231-
# go to GitHub and create the Pull Request
233+
# ... go to GitHub and create the Pull Request
232234
233235
# (optional) make the changes requested by reviewers and commit them
234236
$ git commit xxx.rst

0 commit comments

Comments
 (0)