DOC: Solve review comments of dev docs.

Author: phmbressan

docs/development/conflicts.rst

@@ -25,7 +25,7 @@ It creates a new commit that marks the merging of the two branches together.
 
 **Rebase**
 
-The `rebase` operation integrates changes from one branch into another by replaying \
+The `rebase` operation integrates changes from one branch into another by reapplying \
 the commits on top of the target branch. It results in a more linear history.
 
 * Produces a cleaner, linear commit history.
@@ -81,8 +81,12 @@ When to Use Merge or Rebase
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Generally, the maintainers will inform you which operation to use when merging your PR. \
-Notice that there is no wrong way to merge branches, but it is important to avoid letting \
-conflicts accumulate, since they can become harder to resolve.
+Notice that there is no wrong way to merge branches, but ``rebase`` is usually preferred \
+to keep a more linear history. 
+
+Furthermore, it is important to avoid letting conflicts accumulate, since they can become \
+harder to resolve. It is recommended to update your feature branch frequently with the latest \
+changes from the branch it was branched off.
 
 Solving Conflicts
 -----------------
@@ -111,7 +115,7 @@ When a conflict occurs, VS Code will open the *Merge Editor* to help you resolve
 2. The *Merge Editor* will show the conflicting sections side by side.
 3. Click on the `Accept Current Change` or `Accept Incoming Change` buttons to keep the desired changes, sometimes both changes will be kept or even a manual edit will be necessary.
 
-More details on VS Code interface ans conflict solver can be found in `VS Code Docs <https://code.visualstudio.com/docs/sourcecontrol/overview#_3way-merge-editor>`_.
+More details on VS Code interface and conflict solver can be found in `VS Code Docs <https://code.visualstudio.com/docs/sourcecontrol/overview#_3way-merge-editor>`_.
 After resolving the conflicts, save the files, make sure all conflicts are resolved, and then \
 commit the changes.
 

docs/development/first_pr.rst

@@ -51,13 +51,25 @@ Your branch name should follow the guidelines described in :doc:`/development/st
 Opening the PR
 --------------
 
+After you finish your work, you are more than welcome opening a PR to the RocketPy repository.
+Here are some checks to do before opening a PR:
+
+* Check if the test suite is passing.
+* Format your code using ``black`` and ``isort``.
+
+Check the :doc:`/development/pro_tips` section for more information on how to run these commands.
+
 When you open a PR, you should:
 
 * Use labels to help maintainers understand what the PR is about.
 * Link any issue that may be closed when the PR is merged.
 
 Remember, the PR is yours, not ours! You should keep track of it and update it as needed.
 
+.. important::
+
+    See the :doc:`/development/style_guide` for more information on how to name and \
+    describe your PR.
 
 Continuous Integration (CI)
 ---------------------------

docs/development/pro_tips.rst

@@ -56,7 +56,7 @@ Code assistance
 Artificial Intelligence (AI) assistance has becoming more and more common in
 software development.
 Some editors have AI assistance built-in.
-Famous options are GitHub Copilot, and
+Famous options are GitHub Copilot, JetBrains AI and TabNine.
 
 At this repo, the use of AI tools is welcome, we don't have any restrictions
 against it.

docs/development/setting_up.rst

@@ -35,8 +35,8 @@ There are different ways to do this, but most of them will involve the following
     git clone
 
 
-...
-
+After cloning the repository, you will have a copy of the RocketPy repository on your \ 
+local machine and, by default, you will be on the ``master`` branch. 
 
 .. tip::
 
@@ -48,6 +48,26 @@ There are different ways to do this, but most of them will involve the following
     repository and the remote repository. This connection allows you to push and \
     pull changes between the two repositories.
 
+Navigating through the project
+------------------------------
+
+In order to work on your local repository, you will need to open the directory where you \ 
+cloned it. We recommend using VS Code as your editor, but you can use any editor you prefer.
+If you are using VS Code, you can open the project by running the following command:
+
+.. code-block:: console
+
+    code <path/to/your/folder>
+
+After opening the project for the first time, you will be at the ``master`` branch.
+To switch to another branch, such as the ``develop`` branch, you will need to fetch \
+it from the remote repository and then checkout to it.
+
+.. code-block:: console
+
+    git fetch origin develop
+    git checkout develop
+
 
 Installation
 ------------
@@ -64,27 +84,6 @@ development requirements:
     pip install -r requirements-tests.txt  # install test/dev requirements
 
 
-Navigating through the project
-------------------------------
-
-Opening your editor:
-
-.. code-block:: console
-
-    code <path/to/your/folder>
-
-Moving to a different branch:
-
-.. code-block:: console
-
-    git checkout ...
-
-
-Running a flight simulation
----------------------------
-
-Please see the other page... (link the other page)
-
 Running the tests
 -----------------
 

docs/development/style_guide.rst

@@ -63,6 +63,7 @@ Running these commands before submitting a pull request is also highly recommend
 
 .. code-block:: bash
 
+    make format
     make flake8
     make pylint
 
@@ -71,8 +72,6 @@ The ``flake8`` command will throw a report directly to the console, while the
 ``pylint`` command will create a ``.pylint_report.txt`` file in the root directory,
 which you can open to see the report.
 
-
-
 Documentation Style
 -------------------
 
@@ -164,6 +163,17 @@ Pull Requests
 ^^^^^^^^^^^^^
 
 When opening a Pull Request, the name of the PR should be clear and concise.
+Similarly to the commit messages, the PR name should start with an acronym indicating the type of PR
+and then a brief description of the changes.
+
+Here is an example of a good PR name:
+
+- ``BUG: fix the Frequency Response plot of the Flight class``
+
+The PR description explain the changes and motivation behind them. There is a template \
+available when opening a PR that can be used to guide you through the process of both \
+describing the changes and making sure all the necessary steps were taken. Of course, \
+you can always modify the template or add more information if you think it is necessary.