ARROW-15348: [Doc][Guide] Lifecycle of a PR - minor corrections

Closes apache#12318 from AlenkaF/ARROW-15348 Authored-by: Alenka Frim <[email protected]> Signed-off-by: Joris Van den Bossche <[email protected]>
davidhao3300 · Feb 22, 2022 · 5216c2b · 5216c2b
1 parent ad6dbf6
commit 5216c2b
Show file tree

Hide file tree

Showing 5 changed files with 8 additions and 9 deletions.
diff --git a/docs/source/developers/guide/index.rst b/docs/source/developers/guide/index.rst
@@ -161,4 +161,4 @@ Full Table of Contents
    step_by_step/index
    documentation
    tutorials/index
-   resources
+   resources
diff --git a/docs/source/developers/guide/step_by_step/finding_issues.rst b/docs/source/developers/guide/step_by_step/finding_issues.rst
@@ -117,4 +117,4 @@ Also, do not hesitate to ask questions in the comment section of the issue.
 You can get some pointers about where to start and similar issues already solved.
 
 **Do not forget to create a new branch once you have created or chosen an issue you will be
-working on!** Follow the instructions in the :ref:`pr_and_github` section or follow the next section: :ref:`arrow-codebase`.
+working on!** Follow the instructions in the :ref:`pr_lifecycle` section or follow the next section: :ref:`arrow-codebase`.
diff --git a/docs/source/developers/guide/step_by_step/index.rst b/docs/source/developers/guide/step_by_step/index.rst
@@ -29,4 +29,4 @@ Steps in making your first PR
    finding_issues
    arrow_codebase
    testing
-   pr_and_github
+   pr_lifecycle
diff --git a/...pers/guide/step_by_step/pr_and_github.rst → ...opers/guide/step_by_step/pr_lifecycle.rst b/...pers/guide/step_by_step/pr_and_github.rst → ...opers/guide/step_by_step/pr_lifecycle.rst
@@ -22,7 +22,7 @@
 .. using git.
 
 
-.. _pr_and_github:
+.. _pr_lifecycle:
 
 ***************************
 Lifecycle of a pull request
@@ -42,8 +42,8 @@ have successfully built Arrow and have a JIRA issue to work on.
 **Before making changes to the code, you should create a new
 branch in Git.**
 
-1. Update/sync the code from your ``upstream``
-   in the master branch. Run it in the shell from the ``arrow`` directory.
+1. Update your fork’s master branch with ``upstream/master``.
+   Run this in the shell from the ``arrow`` directory.
 
    .. code:: console
 
@@ -209,7 +209,7 @@ When a pull request is open in the repository you and other developers
 can comment on the proposed solution.
 
 To create a general comment navigate to the **Conversation** tab of
-you pull request and start writing in the comment box at the bottom of
+your pull request and start writing in the comment box at the bottom of
 the page.
 
 You can also comment on a section of the file to point out something

diff --git a/docs/source/developers/guide/tutorials/python_tutorial.rst b/docs/source/developers/guide/tutorials/python_tutorial.rst
@@ -555,5 +555,4 @@ we made can be viewed `here <https://github.com/apache/arrow/pull/11900>`_.
 
 .. seealso::
 
-   For more information about Pull Request workflow see :ref:`pr_and_github`.
-
+   For more information about Pull Request workflow see :ref:`pr_lifecycle`.
Original file line number	Diff line number	Diff line change
Expand Up		@@ -555,5 +555,4 @@ we made can be viewed `here <https://github.com/apache/arrow/pull/11900>`_.

		.. seealso::

		For more information about Pull Request workflow see :ref:`pr_and_github`.

		For more information about Pull Request workflow see :ref:`pr_lifecycle`.