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/06 11:36:18 UTC
[GitHub] [arrow] AlenkaF opened a new pull request #11866: ARROW-14752: [Doc] Steps in making your first PR - Set up
AlenkaF opened a new pull request #11866:
URL: https://github.com/apache/arrow/pull/11866
Add **Set up** section of the guide authored by @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
[GitHub] [arrow] AlenkaF commented on a change in pull request #11866: ARROW-14752: [Doc] Steps in making your first PR - Set up
Posted by GitBox <gi...@apache.org>.
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
[GitHub] [arrow] pitrou commented on a change in pull request #11866: ARROW-14752: [Doc] Steps in making your first PR - Set up
Posted by GitBox <gi...@apache.org>.
pitrou commented on a change in pull request #11866:
URL: https://github.com/apache/arrow/pull/11866#discussion_r764792403
##########
File path: docs/source/developers/guide/step_by_step/set_up.rst
##########
@@ -27,3 +27,95 @@
******
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.
+
+.. 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).
+
+Get the source code
+===================
+
+Fork the repository
+-------------------
+
+The Arrow GitHub repository contains both the Arrow C++ library plus
+libraries for other languages such as Go, Java, Matlab, Python, R, etc.
+The first step to contributing is to create a fork of the repository
+in your own GitHub account.
+
+1. Go to `<https://github.com/apache/arrow>`_.
+
+2. Press Fork in the top right corner.
+
+ .. figure:: github_fork.jpeg
+ :scale: 50 %
+ :alt: Fork the Apache Arrow repository on GitHub.
+
+ The icon to fork the Apache Arrow repository on GitHub.
+
+3. Choose to fork the repository to your username so the fork will be
+ created at ``https://github.com/<your username>/arrow``.
+
+Clone the repository
+--------------------
+
+Next you need to clone the repository (this is where the command line
+comes in). It is *highly recommended* to clone the repository using
+the command line or a Git client. Cloning it in an IDE might create
+unnecessary headaches - for example, cloning it in RStudio assumes the
+whole repository is an RStudio project and will create a ``.Rproj``
+file in the root directory.
+
+.. code:: console
+
+ $ git clone https://github.com/<your username>/arrow.git
+ $ cd arrow
+ $ git remote add upstream https://github.com/apache/arrow
+
+Verify your upstream
+--------------------
+
+Your upstream should be pointing at the Arrow GitHub repo.
+
+Running in the shell:
+
+.. code:: console
+
+ $ git remote -v
+
+Should give you a result similar to this:
+
+.. code:: console
+
+ origin https://github.com/<your username>arrow.git (fetch)
Review comment:
Nit :-)
```suggestion
origin https://github.com/<your username>/arrow.git (fetch)
```
##########
File path: docs/source/developers/guide/step_by_step/set_up.rst
##########
@@ -27,3 +27,95 @@
******
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.
+
+.. 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).
+
+Get the source code
+===================
+
+Fork the repository
+-------------------
+
+The Arrow GitHub repository contains both the Arrow C++ library plus
+libraries for other languages such as Go, Java, Matlab, Python, R, etc.
+The first step to contributing is to create a fork of the repository
+in your own GitHub account.
+
+1. Go to `<https://github.com/apache/arrow>`_.
+
+2. Press Fork in the top right corner.
+
+ .. figure:: github_fork.jpeg
+ :scale: 50 %
+ :alt: Fork the Apache Arrow repository on GitHub.
+
+ The icon to fork the Apache Arrow repository on GitHub.
+
+3. Choose to fork the repository to your username so the fork will be
+ created at ``https://github.com/<your username>/arrow``.
+
+Clone the repository
+--------------------
+
+Next you need to clone the repository (this is where the command line
+comes in). It is *highly recommended* to clone the repository using
+the command line or a Git client. Cloning it in an IDE might create
+unnecessary headaches - for example, cloning it in RStudio assumes the
+whole repository is an RStudio project and will create a ``.Rproj``
+file in the root directory.
Review comment:
Hmm, so I notice we warn against IDEs twice (once here and once above). Should we remove one of them?
--
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
[GitHub] [arrow] pitrou commented on a change in pull request #11866: ARROW-14752: [Doc] Steps in making your first PR - Set up
Posted by GitBox <gi...@apache.org>.
pitrou commented on a change in pull request #11866:
URL: https://github.com/apache/arrow/pull/11866#discussion_r763219934
##########
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:
I'm not sure what the point of this last paragraph is. It seems too vague and uninformative to me. Is there something specific we want to say about the command line here?
##########
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.
+
+Get the source code
+===================
+
+Fork the repository
+-------------------
+
+The Arrow GitHub repository contains both the Arrow C++ library and
+the various bindings to it (libraries in Python, R, Rust, Java, etc.).
Review comment:
Well, except that Rust, Java and other implementations (such as C#, Go or Javascript) are not bindings to Arrow C++; besides, the Rust implementation is in a separate repository ;-)
##########
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.
+
+Get the source code
+===================
+
+Fork the repository
+-------------------
+
+The Arrow GitHub repository contains both the Arrow C++ library and
+the various bindings to it (libraries in Python, R, Rust, Java, etc.).
+The first step to contributing is to create a fork of the repository
+in your own GitHub account.
+
+1. Go to `<https://github.com/apache/arrow>`_.
+
+2. Press Fork in the top right corner.
+
+ .. figure:: github_fork.jpeg
+ :scale: 50 %
+ :alt: Fork the Apache Arrow repository on GitHub.
+
+ The icon to fork the Apache Arrow repository on GitHub.
+
+3. Choose to fork the repository to your username so the fork will be
+ created at ``https://github.com/YOU/arrow``.
Review comment:
I would write this `https://github.com/<your username>/arrow`
##########
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.
+
+Get the source code
+===================
+
+Fork the repository
+-------------------
+
+The Arrow GitHub repository contains both the Arrow C++ library and
+the various bindings to it (libraries in Python, R, Rust, Java, etc.).
+The first step to contributing is to create a fork of the repository
+in your own GitHub account.
+
+1. Go to `<https://github.com/apache/arrow>`_.
+
+2. Press Fork in the top right corner.
+
+ .. figure:: github_fork.jpeg
+ :scale: 50 %
+ :alt: Fork the Apache Arrow repository on GitHub.
+
+ The icon to fork the Apache Arrow repository on GitHub.
+
+3. Choose to fork the repository to your username so the fork will be
+ created at ``https://github.com/YOU/arrow``.
+
+Clone the repository
+--------------------
+
+Next you need to clone the repository (this is where the command line
+comes in). It is *highly recommended* to clone the repository using
+the command line or a Git client. Cloning it in an IDE might create
+unnecessary headaches - for example, cloning it in RStudio assumes the
+whole repository is an R project and will create the ``.Rproj`` file
Review comment:
```suggestion
whole repository is an R project and will create a ``.Rproj`` file
```
##########
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.
+
+Get the source code
+===================
+
+Fork the repository
+-------------------
+
+The Arrow GitHub repository contains both the Arrow C++ library and
+the various bindings to it (libraries in Python, R, Rust, Java, etc.).
+The first step to contributing is to create a fork of the repository
+in your own GitHub account.
+
+1. Go to `<https://github.com/apache/arrow>`_.
+
+2. Press Fork in the top right corner.
+
+ .. figure:: github_fork.jpeg
+ :scale: 50 %
+ :alt: Fork the Apache Arrow repository on GitHub.
+
+ The icon to fork the Apache Arrow repository on GitHub.
+
+3. Choose to fork the repository to your username so the fork will be
+ created at ``https://github.com/YOU/arrow``.
+
+Clone the repository
+--------------------
+
+Next you need to clone the repository (this is where the command line
+comes in). It is *highly recommended* to clone the repository using
+the command line or a Git client. Cloning it in an IDE might create
+unnecessary headaches - for example, cloning it in RStudio assumes the
+whole repository is an R project and will create the ``.Rproj`` file
+in the root directory.
+
+.. code:: console
+
+ $ git clone https://github.com/YOU/arrow.git
Review comment:
```suggestion
$ git clone https://github.com/<your username>/arrow.git
```
##########
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.
+
+Get the source code
+===================
+
+Fork the repository
+-------------------
+
+The Arrow GitHub repository contains both the Arrow C++ library and
+the various bindings to it (libraries in Python, R, Rust, Java, etc.).
+The first step to contributing is to create a fork of the repository
+in your own GitHub account.
+
+1. Go to `<https://github.com/apache/arrow>`_.
+
+2. Press Fork in the top right corner.
+
+ .. figure:: github_fork.jpeg
+ :scale: 50 %
+ :alt: Fork the Apache Arrow repository on GitHub.
+
+ The icon to fork the Apache Arrow repository on GitHub.
+
+3. Choose to fork the repository to your username so the fork will be
+ created at ``https://github.com/YOU/arrow``.
+
+Clone the repository
+--------------------
+
+Next you need to clone the repository (this is where the command line
+comes in). It is *highly recommended* to clone the repository using
+the command line or a Git client. Cloning it in an IDE might create
+unnecessary headaches - for example, cloning it in RStudio assumes the
+whole repository is an R project and will create the ``.Rproj`` file
+in the root directory.
Review comment:
Ha, good to know :-)
##########
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.
+
+Get the source code
+===================
+
+Fork the repository
+-------------------
+
+The Arrow GitHub repository contains both the Arrow C++ library and
+the various bindings to it (libraries in Python, R, Rust, Java, etc.).
+The first step to contributing is to create a fork of the repository
+in your own GitHub account.
+
+1. Go to `<https://github.com/apache/arrow>`_.
+
+2. Press Fork in the top right corner.
+
+ .. figure:: github_fork.jpeg
+ :scale: 50 %
+ :alt: Fork the Apache Arrow repository on GitHub.
+
+ The icon to fork the Apache Arrow repository on GitHub.
+
+3. Choose to fork the repository to your username so the fork will be
+ created at ``https://github.com/YOU/arrow``.
+
+Clone the repository
+--------------------
+
+Next you need to clone the repository (this is where the command line
+comes in). It is *highly recommended* to clone the repository using
+the command line or a Git client. Cloning it in an IDE might create
+unnecessary headaches - for example, cloning it in RStudio assumes the
+whole repository is an R project and will create the ``.Rproj`` file
+in the root directory.
+
+.. code:: console
+
+ $ git clone https://github.com/YOU/arrow.git
+ $ cd arrow
+ $ git remote add upstream https://github.com/apache/arrow
+
+Verify your upstream
+--------------------
+
+Your upstream should be pointing at the Arrow GitHub repo.
+
+Running in the shell:
+
+.. code:: console
+
+ $ git remote -v
+
+Should give you a result similar to this:
+
+.. code:: console
+
+ origin https://github.com/YOU/arrow.git (fetch)
+ origin https://github.com/YOU/arrow.git (push)
+ upstream https://github.com/apache/arrow (fetch)
+ upstream https://github.com/apache/arrow (push)
+
+If you did everything correctly, you should now have a copy of the code
+in the Arrow directory and two remotes that refer to your own GitHub
Review comment:
```suggestion
in the ``arrow`` directory and two remotes that refer to your own GitHub
```
##########
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.
+
+Get the source code
+===================
+
+Fork the repository
+-------------------
+
+The Arrow GitHub repository contains both the Arrow C++ library and
+the various bindings to it (libraries in Python, R, Rust, Java, etc.).
+The first step to contributing is to create a fork of the repository
+in your own GitHub account.
+
+1. Go to `<https://github.com/apache/arrow>`_.
+
+2. Press Fork in the top right corner.
+
+ .. figure:: github_fork.jpeg
+ :scale: 50 %
+ :alt: Fork the Apache Arrow repository on GitHub.
+
+ The icon to fork the Apache Arrow repository on GitHub.
+
+3. Choose to fork the repository to your username so the fork will be
+ created at ``https://github.com/YOU/arrow``.
+
+Clone the repository
+--------------------
+
+Next you need to clone the repository (this is where the command line
+comes in). It is *highly recommended* to clone the repository using
+the command line or a Git client. Cloning it in an IDE might create
+unnecessary headaches - for example, cloning it in RStudio assumes the
+whole repository is an R project and will create the ``.Rproj`` file
+in the root directory.
+
+.. code:: console
+
+ $ git clone https://github.com/YOU/arrow.git
+ $ cd arrow
+ $ git remote add upstream https://github.com/apache/arrow
+
+Verify your upstream
+--------------------
+
+Your upstream should be pointing at the Arrow GitHub repo.
+
+Running in the shell:
+
+.. code:: console
+
+ $ git remote -v
+
+Should give you a result similar to this:
+
+.. code:: console
+
+ origin https://github.com/YOU/arrow.git (fetch)
+ origin https://github.com/YOU/arrow.git (push)
+ upstream https://github.com/apache/arrow (fetch)
+ upstream https://github.com/apache/arrow (push)
+
+If you did everything correctly, you should now have a copy of the code
+in the Arrow directory and two remotes that refer to your own GitHub
+fork (``origin``) and the official Arrow repository (``upstream``).
+
+Note that in the official documentation for Arrow the folder is sometimes
+shown to be cloned into the repository folder. That is not mandatory and
Review comment:
Hmm, I think I don't understand what this means. What is "the repository folder"? I'm a bit confused...
--
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
[GitHub] [arrow] pitrou commented on a change in pull request #11866: ARROW-14752: [Doc] Steps in making your first PR - Set up
Posted by GitBox <gi...@apache.org>.
pitrou commented on a change in pull request #11866:
URL: https://github.com/apache/arrow/pull/11866#discussion_r763741192
##########
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.
+
+Get the source code
+===================
+
+Fork the repository
+-------------------
+
+The Arrow GitHub repository contains both the Arrow C++ library and
+the various bindings to it (libraries in Python, R, Rust, Java, etc.).
+The first step to contributing is to create a fork of the repository
+in your own GitHub account.
+
+1. Go to `<https://github.com/apache/arrow>`_.
+
+2. Press Fork in the top right corner.
+
+ .. figure:: github_fork.jpeg
+ :scale: 50 %
+ :alt: Fork the Apache Arrow repository on GitHub.
+
+ The icon to fork the Apache Arrow repository on GitHub.
+
+3. Choose to fork the repository to your username so the fork will be
+ created at ``https://github.com/YOU/arrow``.
+
+Clone the repository
+--------------------
+
+Next you need to clone the repository (this is where the command line
+comes in). It is *highly recommended* to clone the repository using
+the command line or a Git client. Cloning it in an IDE might create
+unnecessary headaches - for example, cloning it in RStudio assumes the
+whole repository is an R project and will create the ``.Rproj`` file
+in the root directory.
+
+.. code:: console
+
+ $ git clone https://github.com/YOU/arrow.git
+ $ cd arrow
+ $ git remote add upstream https://github.com/apache/arrow
+
+Verify your upstream
+--------------------
+
+Your upstream should be pointing at the Arrow GitHub repo.
+
+Running in the shell:
+
+.. code:: console
+
+ $ git remote -v
+
+Should give you a result similar to this:
+
+.. code:: console
+
+ origin https://github.com/YOU/arrow.git (fetch)
+ origin https://github.com/YOU/arrow.git (push)
+ upstream https://github.com/apache/arrow (fetch)
+ upstream https://github.com/apache/arrow (push)
+
+If you did everything correctly, you should now have a copy of the code
+in the Arrow directory and two remotes that refer to your own GitHub
+fork (``origin``) and the official Arrow repository (``upstream``).
+
+Note that in the official documentation for Arrow the folder is sometimes
+shown to be cloned into the repository folder. That is not mandatory and
Review comment:
Ah! I would rather remove the `mkdir repos` and `cd repos` there entirely. People organize their directories as they want - I don't have a `repos` folder, for example, and I'm sure I'm not the only one :-)
--
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
[GitHub] [arrow] pitrou commented on a change in pull request #11866: ARROW-14752: [Doc] Steps in making your first PR - Set up
Posted by GitBox <gi...@apache.org>.
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 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:
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: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] dragosmg commented on a change in pull request #11866: ARROW-14752: [Doc] Steps in making your first PR - Set up
Posted by GitBox <gi...@apache.org>.
dragosmg commented on a change in pull request #11866:
URL: https://github.com/apache/arrow/pull/11866#discussion_r763784714
##########
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:
RStudio users can clone a repo directly in RStudio without doing it in the terminal. In the case of arrow that is not advised as it creates additional artefacts (an `.Rproj` file) stemming from the idea that, most frequently and R package sits in the root directory of a repo
--
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
[GitHub] [arrow] ursabot commented on pull request #11866: ARROW-14752: [Doc] Steps in making your first PR - Set up
Posted by GitBox <gi...@apache.org>.
ursabot commented on pull request #11866:
URL: https://github.com/apache/arrow/pull/11866#issuecomment-988864592
Benchmark runs are scheduled for baseline = 8d6a8970d4ea13d0a8e9daa46735e16e2b47753b and contender = 9ed9e60f2fdc894de80b73fa1901d3fc34261197. 9ed9e60f2fdc894de80b73fa1901d3fc34261197 is a master commit associated with this PR. Results will be available as each benchmark for each run completes.
Conbench compare runs links:
[Scheduled] [ec2-t3-xlarge-us-east-2](https://conbench.ursa.dev/compare/runs/fb545936d53e47b69d92bf3801d80108...0bfb975824ab4161aaeb8e5642aaa53d/)
[Scheduled] [ursa-i9-9960x](https://conbench.ursa.dev/compare/runs/5913aa7527d04004866cc5cfb9707b4c...746fbd7c56474b3ba8a2d698a509a87a/)
[Scheduled] [ursa-thinkcentre-m75q](https://conbench.ursa.dev/compare/runs/7e19e344d1134b4a96564f2f23dc9562...f955f2402d6b4c3e81a96ea67dc94b04/)
Supported benchmarks:
ec2-t3-xlarge-us-east-2: Supported benchmark langs: Python. Runs only benchmarks with cloud = True
ursa-i9-9960x: Supported benchmark langs: Python, R, JavaScript
ursa-thinkcentre-m75q: Supported benchmark langs: C++, Java
--
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
[GitHub] [arrow] jorisvandenbossche closed pull request #11866: ARROW-14752: [Doc] Steps in making your first PR - Set up
Posted by GitBox <gi...@apache.org>.
jorisvandenbossche closed pull request #11866:
URL: https://github.com/apache/arrow/pull/11866
--
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
[GitHub] [arrow] AlenkaF commented on a change in pull request #11866: ARROW-14752: [Doc] Steps in making your first PR - Set up
Posted by GitBox <gi...@apache.org>.
AlenkaF commented on a change in pull request #11866:
URL: https://github.com/apache/arrow/pull/11866#discussion_r763745678
##########
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.
+
+Get the source code
+===================
+
+Fork the repository
+-------------------
+
+The Arrow GitHub repository contains both the Arrow C++ library and
+the various bindings to it (libraries in Python, R, Rust, Java, etc.).
+The first step to contributing is to create a fork of the repository
+in your own GitHub account.
+
+1. Go to `<https://github.com/apache/arrow>`_.
+
+2. Press Fork in the top right corner.
+
+ .. figure:: github_fork.jpeg
+ :scale: 50 %
+ :alt: Fork the Apache Arrow repository on GitHub.
+
+ The icon to fork the Apache Arrow repository on GitHub.
+
+3. Choose to fork the repository to your username so the fork will be
+ created at ``https://github.com/YOU/arrow``.
+
+Clone the repository
+--------------------
+
+Next you need to clone the repository (this is where the command line
+comes in). It is *highly recommended* to clone the repository using
+the command line or a Git client. Cloning it in an IDE might create
+unnecessary headaches - for example, cloning it in RStudio assumes the
+whole repository is an R project and will create the ``.Rproj`` file
+in the root directory.
+
+.. code:: console
+
+ $ git clone https://github.com/YOU/arrow.git
+ $ cd arrow
+ $ git remote add upstream https://github.com/apache/arrow
+
+Verify your upstream
+--------------------
+
+Your upstream should be pointing at the Arrow GitHub repo.
+
+Running in the shell:
+
+.. code:: console
+
+ $ git remote -v
+
+Should give you a result similar to this:
+
+.. code:: console
+
+ origin https://github.com/YOU/arrow.git (fetch)
+ origin https://github.com/YOU/arrow.git (push)
+ upstream https://github.com/apache/arrow (fetch)
+ upstream https://github.com/apache/arrow (push)
+
+If you did everything correctly, you should now have a copy of the code
+in the Arrow directory and two remotes that refer to your own GitHub
+fork (``origin``) and the official Arrow repository (``upstream``).
+
+Note that in the official documentation for Arrow the folder is sometimes
+shown to be cloned into the repository folder. That is not mandatory and
Review comment:
OK, will do all in this PR if u agree.
--
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
[GitHub] [arrow] ursabot edited a comment on pull request #11866: ARROW-14752: [Doc] Steps in making your first PR - Set up
Posted by GitBox <gi...@apache.org>.
ursabot edited a comment on pull request #11866:
URL: https://github.com/apache/arrow/pull/11866#issuecomment-988864592
Benchmark runs are scheduled for baseline = 8d6a8970d4ea13d0a8e9daa46735e16e2b47753b and contender = 9ed9e60f2fdc894de80b73fa1901d3fc34261197. 9ed9e60f2fdc894de80b73fa1901d3fc34261197 is a master commit associated with this PR. Results will be available as each benchmark for each run completes.
Conbench compare runs links:
[Finished :arrow_down:0.0% :arrow_up:0.0%] [ec2-t3-xlarge-us-east-2](https://conbench.ursa.dev/compare/runs/fb545936d53e47b69d92bf3801d80108...0bfb975824ab4161aaeb8e5642aaa53d/)
[Failed] [ursa-i9-9960x](https://conbench.ursa.dev/compare/runs/5913aa7527d04004866cc5cfb9707b4c...746fbd7c56474b3ba8a2d698a509a87a/)
[Scheduled] [ursa-thinkcentre-m75q](https://conbench.ursa.dev/compare/runs/7e19e344d1134b4a96564f2f23dc9562...f955f2402d6b4c3e81a96ea67dc94b04/)
Supported benchmarks:
ec2-t3-xlarge-us-east-2: Supported benchmark langs: Python. Runs only benchmarks with cloud = True
ursa-i9-9960x: Supported benchmark langs: Python, R, JavaScript
ursa-thinkcentre-m75q: Supported benchmark langs: C++, Java
--
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
[GitHub] [arrow] github-actions[bot] commented on pull request #11866: ARROW-14752: [Doc] Steps in making your first PR - Set up
Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on pull request #11866:
URL: https://github.com/apache/arrow/pull/11866#issuecomment-986693840
https://issues.apache.org/jira/browse/ARROW-14752
--
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
[GitHub] [arrow] thisisnic commented on a change in pull request #11866: ARROW-14752: [Doc] Steps in making your first PR - Set up
Posted by GitBox <gi...@apache.org>.
thisisnic commented on a change in pull request #11866:
URL: https://github.com/apache/arrow/pull/11866#discussion_r764844002
##########
File path: docs/source/developers/guide/step_by_step/set_up.rst
##########
@@ -27,3 +27,100 @@
******
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.
+
+.. 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
Review comment:
```suggestion
Some IDEs allow you to manage a Git repository, but may implicitly run
```
##########
File path: docs/source/developers/guide/step_by_step/set_up.rst
##########
@@ -27,3 +27,100 @@
******
Set up
******
+
+Install and setup Git
Review comment:
```suggestion
Install and set up Git
```
--
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
[GitHub] [arrow] dragosmg commented on a change in pull request #11866: ARROW-14752: [Doc] Steps in making your first PR - Set up
Posted by GitBox <gi...@apache.org>.
dragosmg commented on a change in pull request #11866:
URL: https://github.com/apache/arrow/pull/11866#discussion_r763790726
##########
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.
+
+Get the source code
+===================
+
+Fork the repository
+-------------------
+
+The Arrow GitHub repository contains both the Arrow C++ library and
+the various bindings to it (libraries in Python, R, Rust, Java, etc.).
+The first step to contributing is to create a fork of the repository
+in your own GitHub account.
+
+1. Go to `<https://github.com/apache/arrow>`_.
+
+2. Press Fork in the top right corner.
+
+ .. figure:: github_fork.jpeg
+ :scale: 50 %
+ :alt: Fork the Apache Arrow repository on GitHub.
+
+ The icon to fork the Apache Arrow repository on GitHub.
+
+3. Choose to fork the repository to your username so the fork will be
+ created at ``https://github.com/YOU/arrow``.
+
+Clone the repository
+--------------------
+
+Next you need to clone the repository (this is where the command line
+comes in). It is *highly recommended* to clone the repository using
+the command line or a Git client. Cloning it in an IDE might create
+unnecessary headaches - for example, cloning it in RStudio assumes the
+whole repository is an R project and will create the ``.Rproj`` file
+in the root directory.
Review comment:
the correct wording here would be `RStudio project` instead of `R project`.
--
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
[GitHub] [arrow] pitrou commented on a change in pull request #11866: ARROW-14752: [Doc] Steps in making your first PR - Set up
Posted by GitBox <gi...@apache.org>.
pitrou commented on a change in pull request #11866:
URL: https://github.com/apache/arrow/pull/11866#discussion_r764089302
##########
File path: docs/source/developers/python.rst
##########
@@ -135,18 +135,8 @@ First, let's clone the Arrow git repository:
.. code-block:: shell
- mkdir repos
- cd repos
Review comment:
+1, thank you!
--
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
[GitHub] [arrow] ursabot edited a comment on pull request #11866: ARROW-14752: [Doc] Steps in making your first PR - Set up
Posted by GitBox <gi...@apache.org>.
ursabot edited a comment on pull request #11866:
URL: https://github.com/apache/arrow/pull/11866#issuecomment-988864592
Benchmark runs are scheduled for baseline = 8d6a8970d4ea13d0a8e9daa46735e16e2b47753b and contender = 9ed9e60f2fdc894de80b73fa1901d3fc34261197. 9ed9e60f2fdc894de80b73fa1901d3fc34261197 is a master commit associated with this PR. Results will be available as each benchmark for each run completes.
Conbench compare runs links:
[Finished :arrow_down:0.0% :arrow_up:0.0%] [ec2-t3-xlarge-us-east-2](https://conbench.ursa.dev/compare/runs/fb545936d53e47b69d92bf3801d80108...0bfb975824ab4161aaeb8e5642aaa53d/)
[Failed] [ursa-i9-9960x](https://conbench.ursa.dev/compare/runs/5913aa7527d04004866cc5cfb9707b4c...746fbd7c56474b3ba8a2d698a509a87a/)
[Finished :arrow_down:0.27% :arrow_up:0.09%] [ursa-thinkcentre-m75q](https://conbench.ursa.dev/compare/runs/7e19e344d1134b4a96564f2f23dc9562...f955f2402d6b4c3e81a96ea67dc94b04/)
Supported benchmarks:
ec2-t3-xlarge-us-east-2: Supported benchmark langs: Python. Runs only benchmarks with cloud = True
ursa-i9-9960x: Supported benchmark langs: Python, R, JavaScript
ursa-thinkcentre-m75q: Supported benchmark langs: C++, Java
--
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
[GitHub] [arrow] AlenkaF commented on a change in pull request #11866: ARROW-14752: [Doc] Steps in making your first PR - Set up
Posted by GitBox <gi...@apache.org>.
AlenkaF commented on a change in pull request #11866:
URL: https://github.com/apache/arrow/pull/11866#discussion_r763737906
##########
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.
+
+Get the source code
+===================
+
+Fork the repository
+-------------------
+
+The Arrow GitHub repository contains both the Arrow C++ library and
+the various bindings to it (libraries in Python, R, Rust, Java, etc.).
+The first step to contributing is to create a fork of the repository
+in your own GitHub account.
+
+1. Go to `<https://github.com/apache/arrow>`_.
+
+2. Press Fork in the top right corner.
+
+ .. figure:: github_fork.jpeg
+ :scale: 50 %
+ :alt: Fork the Apache Arrow repository on GitHub.
+
+ The icon to fork the Apache Arrow repository on GitHub.
+
+3. Choose to fork the repository to your username so the fork will be
+ created at ``https://github.com/YOU/arrow``.
+
+Clone the repository
+--------------------
+
+Next you need to clone the repository (this is where the command line
+comes in). It is *highly recommended* to clone the repository using
+the command line or a Git client. Cloning it in an IDE might create
+unnecessary headaches - for example, cloning it in RStudio assumes the
+whole repository is an R project and will create the ``.Rproj`` file
+in the root directory.
+
+.. code:: console
+
+ $ git clone https://github.com/YOU/arrow.git
+ $ cd arrow
+ $ git remote add upstream https://github.com/apache/arrow
+
+Verify your upstream
+--------------------
+
+Your upstream should be pointing at the Arrow GitHub repo.
+
+Running in the shell:
+
+.. code:: console
+
+ $ git remote -v
+
+Should give you a result similar to this:
+
+.. code:: console
+
+ origin https://github.com/YOU/arrow.git (fetch)
+ origin https://github.com/YOU/arrow.git (push)
+ upstream https://github.com/apache/arrow (fetch)
+ upstream https://github.com/apache/arrow (push)
+
+If you did everything correctly, you should now have a copy of the code
+in the Arrow directory and two remotes that refer to your own GitHub
+fork (``origin``) and the official Arrow repository (``upstream``).
+
+Note that in the official documentation for Arrow the folder is sometimes
+shown to be cloned into the repository folder. That is not mandatory and
Review comment:
I added this due to the instructions for [Python Development](https://arrow.apache.org/docs/developers/python.html#environment-setup-and-build) suggesting to add in `Arrow` into `repos` folder.
--
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
[GitHub] [arrow] pitrou commented on a change in pull request #11866: ARROW-14752: [Doc] Steps in making your first PR - Set up
Posted by GitBox <gi...@apache.org>.
pitrou commented on a change in pull request #11866:
URL: https://github.com/apache/arrow/pull/11866#discussion_r763758237
##########
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.
+
+Get the source code
+===================
+
+Fork the repository
+-------------------
+
+The Arrow GitHub repository contains both the Arrow C++ library and
+the various bindings to it (libraries in Python, R, Rust, Java, etc.).
+The first step to contributing is to create a fork of the repository
+in your own GitHub account.
+
+1. Go to `<https://github.com/apache/arrow>`_.
+
+2. Press Fork in the top right corner.
+
+ .. figure:: github_fork.jpeg
+ :scale: 50 %
+ :alt: Fork the Apache Arrow repository on GitHub.
+
+ The icon to fork the Apache Arrow repository on GitHub.
+
+3. Choose to fork the repository to your username so the fork will be
+ created at ``https://github.com/YOU/arrow``.
+
+Clone the repository
+--------------------
+
+Next you need to clone the repository (this is where the command line
+comes in). It is *highly recommended* to clone the repository using
+the command line or a Git client. Cloning it in an IDE might create
+unnecessary headaches - for example, cloning it in RStudio assumes the
+whole repository is an R project and will create the ``.Rproj`` file
+in the root directory.
+
+.. code:: console
+
+ $ git clone https://github.com/YOU/arrow.git
+ $ cd arrow
+ $ git remote add upstream https://github.com/apache/arrow
+
+Verify your upstream
+--------------------
+
+Your upstream should be pointing at the Arrow GitHub repo.
+
+Running in the shell:
+
+.. code:: console
+
+ $ git remote -v
+
+Should give you a result similar to this:
+
+.. code:: console
+
+ origin https://github.com/YOU/arrow.git (fetch)
+ origin https://github.com/YOU/arrow.git (push)
+ upstream https://github.com/apache/arrow (fetch)
+ upstream https://github.com/apache/arrow (push)
+
+If you did everything correctly, you should now have a copy of the code
+in the Arrow directory and two remotes that refer to your own GitHub
+fork (``origin``) and the official Arrow repository (``upstream``).
+
+Note that in the official documentation for Arrow the folder is sometimes
+shown to be cloned into the repository folder. That is not mandatory and
Review comment:
Please do!
--
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
[GitHub] [arrow] dragosmg commented on a change in pull request #11866: ARROW-14752: [Doc] Steps in making your first PR - Set up
Posted by GitBox <gi...@apache.org>.
dragosmg commented on a change in pull request #11866:
URL: https://github.com/apache/arrow/pull/11866#discussion_r763784714
##########
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:
RStudio users can clone a repo directly in RStudio without going through the terminal. In the case of arrow that is not advised as it creates additional artefacts (an `.Rproj` file) stemming from the idea that, most frequently and R package sits in the root directory of a repo
--
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
[GitHub] [arrow] dragosmg commented on a change in pull request #11866: ARROW-14752: [Doc] Steps in making your first PR - Set up
Posted by GitBox <gi...@apache.org>.
dragosmg commented on a change in pull request #11866:
URL: https://github.com/apache/arrow/pull/11866#discussion_r763784714
##########
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:
~RStudio users can clone a repo directly in RStudio without going through the terminal. In the case of arrow that is not advised as it creates additional artefacts (an `.Rproj` file) stemming from the idea that, most frequently and R package sits in the root directory of a repo~
I think I was mostly trying to steer people away from cloning in an IDE and encourage them to use a Terminal
--
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
[GitHub] [arrow] jorisvandenbossche commented on a change in pull request #11866: ARROW-14752: [Doc] Steps in making your first PR - Set up
Posted by GitBox <gi...@apache.org>.
jorisvandenbossche commented on a change in pull request #11866:
URL: https://github.com/apache/arrow/pull/11866#discussion_r764824372
##########
File path: docs/source/developers/guide/step_by_step/set_up.rst
##########
@@ -27,3 +27,95 @@
******
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.
+
+.. 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).
+
+ For example, cloning it in RStudio assumes the whole repository is an
+ RStudio project and will create a ``.Rproj`` file in the root directory.
+ For this reason it is *highly recommended* to clone the repository using
+ the command line or a Git client.
+
+Get the source code
+===================
+
+Fork the repository
+-------------------
+
+The Arrow GitHub repository contains both the Arrow C++ library plus
+libraries for other languages such as Go, Java, Matlab, Python, R, etc.
+The first step to contributing is to create a fork of the repository
+in your own GitHub account.
+
+1. Go to `<https://github.com/apache/arrow>`_.
+
+2. Press Fork in the top right corner.
+
+ .. figure:: github_fork.jpeg
+ :scale: 50 %
+ :alt: Fork the Apache Arrow repository on GitHub.
+
+ The icon to fork the Apache Arrow repository on GitHub.
+
+3. Choose to fork the repository to your username so the fork will be
+ created at ``https://github.com/<your username>/arrow``.
+
+Clone the repository
+--------------------
+
+Next you need to clone the repository.
+
+.. code:: console
+
+ $ git clone https://github.com/<your username>/arrow.git
+ $ cd arrow
+ $ git remote add upstream https://github.com/apache/arrow
Review comment:
Maybe either mention this line in the section below, or either already mention in this section that you also add the upstream Apache Arrow repo as a remote called "upstream"?
--
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
[GitHub] [arrow] AlenkaF commented on a change in pull request #11866: ARROW-14752: [Doc] Steps in making your first PR - Set up
Posted by GitBox <gi...@apache.org>.
AlenkaF commented on a change in pull request #11866:
URL: https://github.com/apache/arrow/pull/11866#discussion_r764827765
##########
File path: docs/source/developers/guide/step_by_step/set_up.rst
##########
@@ -27,3 +27,95 @@
******
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.
+
+.. 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).
+
+ For example, cloning it in RStudio assumes the whole repository is an
+ RStudio project and will create a ``.Rproj`` file in the root directory.
+ For this reason it is *highly recommended* to clone the repository using
+ the command line or a Git client.
+
+Get the source code
+===================
+
+Fork the repository
+-------------------
+
+The Arrow GitHub repository contains both the Arrow C++ library plus
+libraries for other languages such as Go, Java, Matlab, Python, R, etc.
+The first step to contributing is to create a fork of the repository
+in your own GitHub account.
+
+1. Go to `<https://github.com/apache/arrow>`_.
+
+2. Press Fork in the top right corner.
+
+ .. figure:: github_fork.jpeg
+ :scale: 50 %
+ :alt: Fork the Apache Arrow repository on GitHub.
+
+ The icon to fork the Apache Arrow repository on GitHub.
+
+3. Choose to fork the repository to your username so the fork will be
+ created at ``https://github.com/<your username>/arrow``.
+
+Clone the repository
+--------------------
+
+Next you need to clone the repository.
+
+.. code:: console
+
+ $ git clone https://github.com/<your username>/arrow.git
+ $ cd arrow
+ $ git remote add upstream https://github.com/apache/arrow
Review comment:
Will do!
--
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
[GitHub] [arrow] ursabot edited a comment on pull request #11866: ARROW-14752: [Doc] Steps in making your first PR - Set up
Posted by GitBox <gi...@apache.org>.
ursabot edited a comment on pull request #11866:
URL: https://github.com/apache/arrow/pull/11866#issuecomment-988864592
Benchmark runs are scheduled for baseline = 8d6a8970d4ea13d0a8e9daa46735e16e2b47753b and contender = 9ed9e60f2fdc894de80b73fa1901d3fc34261197. 9ed9e60f2fdc894de80b73fa1901d3fc34261197 is a master commit associated with this PR. Results will be available as each benchmark for each run completes.
Conbench compare runs links:
[Finished :arrow_down:0.0% :arrow_up:0.0%] [ec2-t3-xlarge-us-east-2](https://conbench.ursa.dev/compare/runs/fb545936d53e47b69d92bf3801d80108...0bfb975824ab4161aaeb8e5642aaa53d/)
[Scheduled] [ursa-i9-9960x](https://conbench.ursa.dev/compare/runs/5913aa7527d04004866cc5cfb9707b4c...746fbd7c56474b3ba8a2d698a509a87a/)
[Scheduled] [ursa-thinkcentre-m75q](https://conbench.ursa.dev/compare/runs/7e19e344d1134b4a96564f2f23dc9562...f955f2402d6b4c3e81a96ea67dc94b04/)
Supported benchmarks:
ec2-t3-xlarge-us-east-2: Supported benchmark langs: Python. Runs only benchmarks with cloud = True
ursa-i9-9960x: Supported benchmark langs: Python, R, JavaScript
ursa-thinkcentre-m75q: Supported benchmark langs: C++, Java
--
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
[GitHub] [arrow] AlenkaF commented on a change in pull request #11866: ARROW-14752: [Doc] Steps in making your first PR - Set up
Posted by GitBox <gi...@apache.org>.
AlenkaF commented on a change in pull request #11866:
URL: https://github.com/apache/arrow/pull/11866#discussion_r764832547
##########
File path: docs/source/developers/guide/step_by_step/set_up.rst
##########
@@ -27,3 +27,95 @@
******
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.
+
+.. 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).
+
+ For example, cloning it in RStudio assumes the whole repository is an
+ RStudio project and will create a ``.Rproj`` file in the root directory.
+ For this reason it is *highly recommended* to clone the repository using
+ the command line or a Git client.
+
+Get the source code
+===================
+
+Fork the repository
+-------------------
+
+The Arrow GitHub repository contains both the Arrow C++ library plus
+libraries for other languages such as Go, Java, Matlab, Python, R, etc.
+The first step to contributing is to create a fork of the repository
+in your own GitHub account.
+
+1. Go to `<https://github.com/apache/arrow>`_.
+
+2. Press Fork in the top right corner.
+
+ .. figure:: github_fork.jpeg
+ :scale: 50 %
+ :alt: Fork the Apache Arrow repository on GitHub.
+
+ The icon to fork the Apache Arrow repository on GitHub.
+
+3. Choose to fork the repository to your username so the fork will be
+ created at ``https://github.com/<your username>/arrow``.
+
+Clone the repository
+--------------------
+
+Next you need to clone the repository.
+
+.. code:: console
+
+ $ git clone https://github.com/<your username>/arrow.git
+ $ cd arrow
+ $ git remote add upstream https://github.com/apache/arrow
Review comment:
btw `.. code:: console` works great! =)
--
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