jorisvandenbossche commented on a change in pull request #11837:
URL: https://github.com/apache/arrow/pull/11837#discussion_r761175620
##########
File path: docs/source/developers/guide/step_by_step/pr_and_github.rst
##########
@@ -24,14 +24,162 @@
.. _pr_and_github:
-****************************
-Lifecycle of a Pull Request
-****************************
+******************************
+Lifecycle of a Pull Request 🙀
+******************************
+:ref:`As mentioned before<set-up>`, Arrow project uses git for
+version control and a workflow based on Pull Requests. That means
+that you contribute the changes to the code by creating a branch
+in Git, make changes to the code, push the changes to you ``origin``
Review comment:
```suggestion
in Git, make changes to the code, push the changes to your ``origin``
```
##########
File path: docs/source/developers/guide/step_by_step/pr_and_github.rst
##########
@@ -24,14 +24,162 @@
.. _pr_and_github:
-****************************
-Lifecycle of a Pull Request
-****************************
+******************************
+Lifecycle of a Pull Request 🙀
+******************************
+:ref:`As mentioned before<set-up>`, Arrow project uses git for
+version control and a workflow based on Pull Requests. That means
+that you contribute the changes to the code by creating a branch
+in Git, make changes to the code, push the changes to you ``origin``
+which is your fork of the Arrow repository on GitHub and then you
+create a **Pull Request** against the official Arrow repository
+which is saved in your set up as ``upstream``.
-Creating a PR 🙀
-================
+You should have git set up by now, have your source code,
+have successfully built Arrow and have an JIRA issue to work on.
+**Before making changes to the code, you should create a new
+branch in Git.**
-Reviews and get the PR merge 🎉
-===============================
\ No newline at end of file
+1. Update/sync the code from your ``upstream``
+ in the master branch. Run it in the shell from ``arrow`` directory.
+
+ .. code-block:: shell
+
+ $ git checkout master
+ $ git fetch upstream
+ $ git pull --ff-only upstream master
+
+2. Create a new branch
+
+ .. code-block:: shell
+
+ $ git checkout -b <branch-name>
+
+Now you can make changes to the code. To see the changes
+made in the library use this two commands:
+
+.. code-block:: shell
+
+ $ git status # to see what files are changed
+ $ git diff # to see code change per file
+
+Creating a Pull Request
+=======================
+
+Once you are satisfied with the changes, run the :ref:`tests <testing>`
+and linters and then go ahead and commit the changes.
+
+3. Add and commit the changes
Review comment:
Just wondering, do those numbers work? (it might be that sphinx
automatically renumbers them and starts counting at 1 because this is a new
list. But if that's the case, there should also be a way to turn that off)
##########
File path: docs/source/developers/guide/step_by_step/pr_and_github.rst
##########
@@ -24,14 +24,162 @@
.. _pr_and_github:
-****************************
-Lifecycle of a Pull Request
-****************************
+******************************
+Lifecycle of a Pull Request 🙀
+******************************
+:ref:`As mentioned before<set-up>`, Arrow project uses git for
+version control and a workflow based on Pull Requests. That means
+that you contribute the changes to the code by creating a branch
+in Git, make changes to the code, push the changes to you ``origin``
+which is your fork of the Arrow repository on GitHub and then you
+create a **Pull Request** against the official Arrow repository
+which is saved in your set up as ``upstream``.
-Creating a PR 🙀
-================
+You should have git set up by now, have your source code,
Review comment:
"have your source code" -> "have cloned the repo"? or "have the source
code locally"
##########
File path: docs/source/developers/guide/step_by_step/pr_and_github.rst
##########
@@ -24,14 +24,162 @@
.. _pr_and_github:
-****************************
-Lifecycle of a Pull Request
-****************************
+******************************
+Lifecycle of a Pull Request 🙀
+******************************
+:ref:`As mentioned before<set-up>`, Arrow project uses git for
+version control and a workflow based on Pull Requests. That means
+that you contribute the changes to the code by creating a branch
+in Git, make changes to the code, push the changes to you ``origin``
+which is your fork of the Arrow repository on GitHub and then you
+create a **Pull Request** against the official Arrow repository
+which is saved in your set up as ``upstream``.
-Creating a PR 🙀
-================
+You should have git set up by now, have your source code,
+have successfully built Arrow and have an JIRA issue to work on.
+**Before making changes to the code, you should create a new
+branch in Git.**
-Reviews and get the PR merge 🎉
-===============================
\ No newline at end of file
+1. Update/sync the code from your ``upstream``
+ in the master branch. Run it in the shell from ``arrow`` directory.
+
+ .. code-block:: shell
+
+ $ git checkout master
+ $ git fetch upstream
+ $ git pull --ff-only upstream master
+
+2. Create a new branch
+
+ .. code-block:: shell
+
+ $ git checkout -b <branch-name>
Review comment:
this could also be `git switch --create <branch-name>` (I don't know to
what extent people already use those new commands)
##########
File path: docs/source/developers/guide/step_by_step/pr_and_github.rst
##########
@@ -24,14 +24,162 @@
.. _pr_and_github:
-****************************
-Lifecycle of a Pull Request
-****************************
+******************************
+Lifecycle of a Pull Request 🙀
+******************************
+:ref:`As mentioned before<set-up>`, Arrow project uses git for
Review comment:
```suggestion
:ref:`As mentioned before<set-up>`, the Arrow project uses git for
```
##########
File path: docs/source/developers/guide/step_by_step/pr_and_github.rst
##########
@@ -24,14 +24,162 @@
.. _pr_and_github:
-****************************
-Lifecycle of a Pull Request
-****************************
+******************************
+Lifecycle of a Pull Request 🙀
+******************************
+:ref:`As mentioned before<set-up>`, Arrow project uses git for
+version control and a workflow based on Pull Requests. That means
+that you contribute the changes to the code by creating a branch
+in Git, make changes to the code, push the changes to you ``origin``
+which is your fork of the Arrow repository on GitHub and then you
+create a **Pull Request** against the official Arrow repository
+which is saved in your set up as ``upstream``.
-Creating a PR 🙀
-================
+You should have git set up by now, have your source code,
+have successfully built Arrow and have an JIRA issue to work on.
+**Before making changes to the code, you should create a new
+branch in Git.**
-Reviews and get the PR merge 🎉
-===============================
\ No newline at end of file
+1. Update/sync the code from your ``upstream``
+ in the master branch. Run it in the shell from ``arrow`` directory.
+
+ .. code-block:: shell
+
+ $ git checkout master
+ $ git fetch upstream
+ $ git pull --ff-only upstream master
+
+2. Create a new branch
+
+ .. code-block:: shell
+
+ $ git checkout -b <branch-name>
+
+Now you can make changes to the code. To see the changes
+made in the library use this two commands:
+
+.. code-block:: shell
+
+ $ git status # to see what files are changed
+ $ git diff # to see code change per file
+
+Creating a Pull Request
+=======================
+
+Once you are satisfied with the changes, run the :ref:`tests <testing>`
+and linters and then go ahead and commit the changes.
+
+3. Add and commit the changes
+
+ .. code-block:: shell
+
+ $ git add <filenames>
+ $ git commit -m '<message>'
+
+ Or you can add and commit in one step, if all the files changed
+ are to be committed
+
+ .. code-block:: shell
+
+ $ git commit -a -m '<message>'
+
+4. Then push your work to your Arrow fork
+
+ .. code-block:: shell
+
+ $ git push origin <branch-name>
+
+.. note::
+
+ Your work is now still under your watchful eye so no problem if you
+ see any error you would like to correct. You can make an additional
+ commit to correct. Also Git has lots of ways to
+ amend, delete, revise, etc. See https://git-scm.com/docs for more
+ information.
+
+ Until you make the Pull Request, nothing is visible on the Arrow
+ repository and you are free to experiment.
+
+If all is set, you can make the Pull Request!
+
+5. Go to ``https://github.com/YOU/arrow`` where you will see a box with
+ the name of the branch that you pushed and next to it a green button
+ **Compare & Pull Request**. Clicking on it you should add a title and
Review comment:
```suggestion
**Compare & Pull Request**. After clicking on it, you should add a title
and
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
