pitrou commented on a change in pull request #11837:
URL: https://github.com/apache/arrow/pull/11837#discussion_r767943636
##########
File path: docs/source/developers/guide/step_by_step/pr_and_github.rst
##########
@@ -24,14 +24,202 @@
.. _pr_and_github:
-****************************
-Lifecycle of a Pull Request
-****************************
+******************************
+Lifecycle of a Pull Request 🙀
+******************************
+:ref:`As mentioned before<set-up>`, the 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 your ``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 cloned the repository,
+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.**
-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 the ``arrow`` directory.
+
+ .. code:: console
+
+ $ git checkout master # select the main Arrow branch
+ $ git fetch upstream # check for changes in upstream/master
+ $ git pull --ff-only upstream master # save the changes from
upstream/master
Review comment:
I'm a bit surprised by this workflow. I never ever use `git pull
--ff-only`, basically I only run `git pull` on master and that's sufficient.
##########
File path: docs/source/developers/guide/step_by_step/pr_and_github.rst
##########
@@ -24,14 +24,202 @@
.. _pr_and_github:
-****************************
-Lifecycle of a Pull Request
-****************************
+******************************
+Lifecycle of a Pull Request 🙀
+******************************
+:ref:`As mentioned before<set-up>`, the 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 your ``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 cloned the repository,
+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.**
-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 the ``arrow`` directory.
+
+ .. code:: console
+
+ $ git checkout master # select the main Arrow branch
+ $ git fetch upstream # check for changes in upstream/master
+ $ git pull --ff-only upstream master # save the changes from
upstream/master
+
+ Note: ``--ff-only`` applies changes only if they can be fast-forwarded
+ without conficts or creating merge commits.
+
+2. Create a new branch
+
+ .. code:: console
+
+ $ git checkout -b <branch-name>
+
+ or (does the same thing)
+
+ .. code:: console
+
+ $ git switch --create <branch-name>
+
+Now you can make changes to the code. To see the changes
+made in the library use this two commands:
+
+.. code:: console
+
+ $ 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:: console
+
+ $ git add <filenames>
+ $ git commit -m "<message>"
+
+ Alternatively, you can add and commit in one step, if all the files changed
+ are to be committed (-a to add all, -m for message)
+
+ .. code:: console
+
+ $ git commit -am "<message>"
+
+4. Then push your work to your Arrow fork
+
+ .. code:: console
+
+ $ git push origin <branch-name>
+
+.. note::
+
+ Your work is now still under your watchful eye so it's not a problem
+ if you see any errors you would like to correct. You can make an
+ additional commit to correct, and 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/<your username>arrow`` where you will see a box
with
Review comment:
```suggestion
5. Go to ``https://github.com/<your username>/arrow`` where you will see a
box with
```
##########
File path: docs/source/developers/guide/step_by_step/pr_and_github.rst
##########
@@ -24,14 +24,202 @@
.. _pr_and_github:
-****************************
-Lifecycle of a Pull Request
-****************************
+******************************
+Lifecycle of a Pull Request 🙀
Review comment:
Not sure what the emoticon is supposed to convey, but it doesn't really
seem useful or related to the topic?
--
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]
