You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@arrow.apache.org by GitBox <gi...@apache.org> on 2021/12/07 08:12:28 UTC

[GitHub] [arrow] AlenkaF commented on a change in pull request #11866: ARROW-14752: [Doc] Steps in making your first PR - Set up

AlenkaF commented on a change in pull request #11866:
URL: https://github.com/apache/arrow/pull/11866#discussion_r763731136



##########
File path: docs/source/developers/guide/step_by_step/set_up.rst
##########
@@ -27,3 +27,98 @@
 ******
 Set up
 ******
+
+Install and setup Git
+=====================
+
+The Arrow project is developed using `git <https://git-scm.com/>`_
+for version control which is easily available for all common
+operating systems.
+
+You can follow the instructions to install git from GitHub
+where Arrow repository is hosted, following
+`the quickstart instructions <https://docs.github.com/en/get-started/quickstart/set-up-git>`_.
+
+When git is set up do not forget to configure your name and email
+
+.. code:: console
+
+   $ git config --global user.name "Your Name"
+   $ git config --global user.email your.email@example.com
+
+and `authenticate with GitHub <https://docs.github.com/en/get-started/quickstart/set-up-git#next-steps-authenticating-with-github-from-git>`_
+as this will allow you to interact with GitHub without typing
+a username and password each time you execute a git command.
+
+**The Terminal**
+
+You might be able to get away without using the command-line for
+most tasks, but for some it seems to be the most straightforward way.

Review comment:
       This was added, if I remember correctly, because not all Arrow users are used to work with the command-line. It serves as a soft warning =) It is not necessary information to have but it is a note to get acquainted with the tool. Was thinking of adding a link with basic terminal commands also.
   
   cc @dragosmg 




-- 
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: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org