pitrou commented on a change in pull request #11866: URL: https://github.com/apache/arrow/pull/11866#discussion_r764089062
########## 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 [email protected] + +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: Then this should be more explicit about it, for example: ```restructuredtext .. note:: This guide assumes you are comfortable working from the command line. Some IDEs allow you to manage a git repository, but may implicitly run unwanted operations when doing so (such as creating project files). ``` -- 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]
