From 45773edc1de03ffeea4797a9c079332f82c46ce9 Mon Sep 17 00:00:00 2001 From: willy-ahva Date: Fri, 15 Apr 2016 11:17:55 +0200 Subject: [PATCH] [Documentation] Fix typo --- docs/contributing/code/patches.rst | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/contributing/code/patches.rst b/docs/contributing/code/patches.rst index b418ec29787..66aafe35fa7 100644 --- a/docs/contributing/code/patches.rst +++ b/docs/contributing/code/patches.rst @@ -10,7 +10,7 @@ Step 1: Setup your Environment Install the Software Stack ~~~~~~~~~~~~~~~~~~~~~~~~~~ -Before working on Sylius, setup a Symfony friendly environment with the following +Before working on Sylius, set a Symfony friendly environment up with the following software: * Git @@ -20,12 +20,12 @@ software: Configure Git ~~~~~~~~~~~~~ -Set up your user information with your real name and a working email address: +Set your user information up with your real name and a working email address: .. code-block:: bash $ git config --global user.name "Your Name" - $ git config --global user.email you@example.com + $ git config --global user.email "you@example.com" .. tip:: @@ -34,7 +34,7 @@ Set up your user information with your real name and a working email address: .. tip:: - If your IDE creates configuration files inside the project's directory, + If your IDE creates configuration files inside the directory of the project, you can use global ``.gitignore`` file (for all projects) or ``.git/info/exclude`` file (per project) to ignore them. See `Github's documentation`_. @@ -42,7 +42,7 @@ Set up your user information with your real name and a working email address: .. tip:: Windows users: when installing Git, the installer will ask what to do with - line endings, and suggests replacing all LF with CRLF. This is the wrong + line endings, and will suggest replacing all LF with CRLF. This is the wrong setting if you wish to contribute to Sylius. Selecting the as-is method is your best choice, as Git will convert your line feeds to the ones in the repository. If you have already installed Git, you can check the value of @@ -91,7 +91,7 @@ Step 2: Work on your Patch The License ~~~~~~~~~~~ -Before you start, you must know that all the patches you are going to submit +Before you start, you must know that all patches you are going to submit must be released under the *MIT license*, unless explicitly specified in your commits. @@ -122,7 +122,7 @@ topic branch, starting from the previously chosen base branch: Use a descriptive name for your branch (``issue_XXX`` where ``XXX`` is the GitHub issue number is a good convention for bug fixes). -The above checkout commands automatically switch the code to the newly created +The above checkout command automatically switches the code to the newly created branch (check the branch you are working on with ``git branch``). Work on your Patch