doc: added additional explanation for clarification

checkstyle · May 2, 2024 · 0701553 · 0701553
1 parent 7e70a79
commit 0701553
Showing 1 changed file with 10 additions and 8 deletions.
diff --git a/src/xdocs/beginning_development.xml b/src/xdocs/beginning_development.xml
@@ -23,16 +23,16 @@
         Prepare development environment in Ubuntu</a>.<br/>
         2. Fork Checkstyle upstream project. As it is described
         <a href="https://help.github.com/articles/fork-a-repo/"> here</a><br/>
-        3. Checkout the current source code from: https://github.com/you_user_name/checkstyle/<br/>
-        by running
+        3. Clone your forked repository to your computer:
       </p>
       <div class="wrap-content">
         <source>
-            git clone git@github.com:you_user_name/checkstyle.git
+            git clone git@github.com:your_user_name/checkstyle.git
         </source>
       </div>
       <p>
-        4. Before opening project in IDE do build in terminal by running in repository root folder
+        4. Before opening project in your IDE, build the project in your terminal to download<br/>
+        all needed artifacts. From the repository root folder, run:
       </p>
       <div class="wrap-content">
         <source>
@@ -51,7 +51,8 @@
 
       <p>
         Follow these instructions of Git usage and creating a Pull Request:<br/>
-           1) Configure remotes:
+           1) Configure remotes by pointing to the official checkstyle repository,<br/>
+        naming it "upstream":
       </p>
       <div class="wrap-content">
         <source>
@@ -107,7 +108,7 @@
         </source>
       </div>
       <p>
-           7) Rebase your branch over your updated master
+           7) Rebase your branch on your updated master:
       </p>
       <div class="wrap-content">
         <source>
@@ -118,9 +119,10 @@
       <p>
            8) In the process of the rebase, it may discover conflicts.<br/>
            In that case it will stop and allow you to fix the conflicts.<br/>
-           After fixing conflicts, use git add . to update the index with those contents,<br/>
-           and then just run:
+           After fixing conflicts, use
       </p>
+      <source>git add .</source>
+      <p> to update the index with those contents, and then just run:</p>
       <div class="wrap-content">
         <source>
           git rebase --continue