thisisnic commented on a change in pull request #11677: URL: https://github.com/apache/arrow/pull/11677#discussion_r758326420
########## File path: docs/source/developers/guide/introduction.rst ########## @@ -0,0 +1,154 @@ +.. Licensed to the Apache Software Foundation (ASF) under one +.. or more contributor license agreements. See the NOTICE file +.. distributed with this work for additional information +.. regarding copyright ownership. The ASF licenses this file +.. to you under the Apache License, Version 2.0 (the +.. "License"); you may not use this file except in compliance +.. with the License. You may obtain a copy of the License at + +.. http://www.apache.org/licenses/LICENSE-2.0 + +.. Unless required by applicable law or agreed to in writing, +.. software distributed under the License is distributed on an +.. "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +.. KIND, either express or implied. See the License for the +.. specific language governing permissions and limitations +.. under the License. + + +.. SCOPE OF THIS SECTION +.. Make an introduction to the Guide for New Contributors. +.. Add an introduction to the project, why to get involved +.. and a quick checklist of the contributing process. +.. Add the Table of Contents. All detailed explanations +.. should be added as a link in the content. + + +.. _introduction: + +*********************** +New Contributor's Guide +*********************** + +This guide is meant to be a resource for contributing to +`Arrow <https://arrow.apache.org>`_ for new contributors. + +No matter what your current skills are you can try and make Review comment: ```suggestion No matter what your current skills are, you can try and make ``` ########## File path: docs/source/developers/guide/step_by_step/building.rst ########## @@ -0,0 +1,51 @@ +.. Licensed to the Apache Software Foundation (ASF) under one +.. or more contributor license agreements. See the NOTICE file +.. distributed with this work for additional information +.. regarding copyright ownership. The ASF licenses this file +.. to you under the Apache License, Version 2.0 (the +.. "License"); you may not use this file except in compliance +.. with the License. You may obtain a copy of the License at + +.. http://www.apache.org/licenses/LICENSE-2.0 + +.. Unless required by applicable law or agreed to in writing, +.. software distributed under the License is distributed on an +.. "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +.. KIND, either express or implied. See the License for the +.. specific language governing permissions and limitations +.. under the License. + + +.. SCOPE OF THIS SECTION +.. The aim of this section is to provide extra description to +.. the process of building Arow library. It could include: +.. what does building mean, what is CMake, what are flags and why +.. do we use them, is building Arrow supposed to be straigtforward? +.. etc. + +.. Be sure not to duplicate with existing documentation! +.. All language-specific instructions about building, testing, +.. installing dependencies, etc. should go into language-specific +.. documentation. + + +.. _build-arrow: + +***************************** +Building Arrow's libraries 🏋🏿♀️ +***************************** + + + +Building C++ +============ + +.. _build-pyarrow: + +Building PyArrow +================ + +.. _build-rarrow: + +Building R-Arrow Review comment: ```suggestion Building the R package ``` ########## File path: docs/source/developers/guide/step_by_step/pr_and_github.rst ########## @@ -0,0 +1,37 @@ +.. Licensed to the Apache Software Foundation (ASF) under one +.. or more contributor license agreements. See the NOTICE file +.. distributed with this work for additional information +.. regarding copyright ownership. The ASF licenses this file +.. to you under the Apache License, Version 2.0 (the +.. "License"); you may not use this file except in compliance +.. with the License. You may obtain a copy of the License at + +.. http://www.apache.org/licenses/LICENSE-2.0 + +.. Unless required by applicable law or agreed to in writing, +.. software distributed under the License is distributed on an +.. "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +.. KIND, either express or implied. See the License for the +.. specific language governing permissions and limitations +.. under the License. + + +.. SCOPE OF THIS SECTION +.. This section should include all steps in making a pull +.. request (until it is merged) on Arrow GitHub repository +.. using git. + + +.. _pr_and_github: + +**************************** +Life cycle of a Pull Request Review comment: ```suggestion Lifecycle of a Pull Request ``` ########## File path: docs/source/developers/guide/introduction.rst ########## @@ -0,0 +1,154 @@ +.. Licensed to the Apache Software Foundation (ASF) under one +.. or more contributor license agreements. See the NOTICE file +.. distributed with this work for additional information +.. regarding copyright ownership. The ASF licenses this file +.. to you under the Apache License, Version 2.0 (the +.. "License"); you may not use this file except in compliance +.. with the License. You may obtain a copy of the License at + +.. http://www.apache.org/licenses/LICENSE-2.0 + +.. Unless required by applicable law or agreed to in writing, +.. software distributed under the License is distributed on an +.. "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +.. KIND, either express or implied. See the License for the +.. specific language governing permissions and limitations +.. under the License. + + +.. SCOPE OF THIS SECTION +.. Make an introduction to the Guide for New Contributors. +.. Add an introduction to the project, why to get involved +.. and a quick checklist of the contributing process. +.. Add the Table of Contents. All detailed explanations +.. should be added as a link in the content. + + +.. _introduction: + +*********************** +New Contributor's Guide +*********************** + +This guide is meant to be a resource for contributing to +`Arrow <https://arrow.apache.org>`_ for new contributors. + +No matter what your current skills are you can try and make +your first time contribution to Arrow. + +Starting to contribute to a project like Apache Arrow can be +intimidating. Taking small steps will help making this tack +easier. + + +Why contribute to Arrow? +======================== +There can be various reasons why someone would want to contribute +to Arrow: + +* You find the project interesting and would like to try making + a contribution to learn more about the library and grow your skills. + +* You use Arrow in the project you are working on and you would like + to implement a new feature. + +Read more about the project in the :ref:`architectural_overview` section. + +Quick Reference +=============== + +Here are the basic steps needed to get set up and contribute to Arrow. +This is meant as a checklist and also to have an overall picture. + +For complete instructions please follow :ref:`step_by_step` (a +step-by-step guide) or R and Python :ref:`tutorial-index` for an example +of adding a basic feature. + + +#. **Install and set up Git, fork the Arrow repository** + + See detailed instructions on how to :ref:`set-up` Git and fork the + Arrow repository. + +#. **Build Arrow** + + Arrow libraries include a wide range of functionalities and may require + the installation of third-party packages, depending on which build + options and components you enable. For example, the C++ build guide + has suggestions for whenever you are experiencing difficulties, be sure + to read them. Anytime you are stuck, feel free to reach out via + appropriate :ref:`communication` channel. + + See a short description about the building process of + :ref:`PyArrow or R-Arrow<build-arrow>` or go straight to detailed + instructions on how to build one of Arrow libraries in the + `documentation <https://arrow.apache.org/docs/>`_ . + +#. **Run the tests** + + Run the tests from a terminal for Python + + .. code-block:: + + $ pytest pyarrow + + or in R console for R + + .. code-block:: R + + devtools::test() + + See also the section on :ref:`testing`. + +#. **Find an issue (if needed), create a new branch and work on the problem** + + **Finding an issue** + + You can have a new bug or a new feature you want to implement. But if you Review comment: ```suggestion You might already have a bug to fix in mind, or a new feature that you want to implement. But if you ``` ########## File path: docs/source/developers/guide/introduction.rst ########## @@ -0,0 +1,154 @@ +.. Licensed to the Apache Software Foundation (ASF) under one +.. or more contributor license agreements. See the NOTICE file +.. distributed with this work for additional information +.. regarding copyright ownership. The ASF licenses this file +.. to you under the Apache License, Version 2.0 (the +.. "License"); you may not use this file except in compliance +.. with the License. You may obtain a copy of the License at + +.. http://www.apache.org/licenses/LICENSE-2.0 + +.. Unless required by applicable law or agreed to in writing, +.. software distributed under the License is distributed on an +.. "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +.. KIND, either express or implied. See the License for the +.. specific language governing permissions and limitations +.. under the License. + + +.. SCOPE OF THIS SECTION +.. Make an introduction to the Guide for New Contributors. +.. Add an introduction to the project, why to get involved +.. and a quick checklist of the contributing process. +.. Add the Table of Contents. All detailed explanations +.. should be added as a link in the content. + + +.. _introduction: + +*********************** +New Contributor's Guide +*********************** + +This guide is meant to be a resource for contributing to +`Arrow <https://arrow.apache.org>`_ for new contributors. + +No matter what your current skills are you can try and make +your first time contribution to Arrow. + +Starting to contribute to a project like Apache Arrow can be +intimidating. Taking small steps will help making this tack +easier. + + +Why contribute to Arrow? +======================== +There can be various reasons why someone would want to contribute +to Arrow: + +* You find the project interesting and would like to try making + a contribution to learn more about the library and grow your skills. + +* You use Arrow in the project you are working on and you would like + to implement a new feature. + +Read more about the project in the :ref:`architectural_overview` section. + +Quick Reference +=============== + +Here are the basic steps needed to get set up and contribute to Arrow. +This is meant as a checklist and also to have an overall picture. + +For complete instructions please follow :ref:`step_by_step` (a +step-by-step guide) or R and Python :ref:`tutorial-index` for an example +of adding a basic feature. + + +#. **Install and set up Git, fork the Arrow repository** + + See detailed instructions on how to :ref:`set-up` Git and fork the + Arrow repository. + +#. **Build Arrow** + + Arrow libraries include a wide range of functionalities and may require + the installation of third-party packages, depending on which build + options and components you enable. For example, the C++ build guide + has suggestions for whenever you are experiencing difficulties, be sure + to read them. Anytime you are stuck, feel free to reach out via Review comment: ```suggestion options and components you enable. The C++ build guide has suggestions for commonly encountered issues - you can find it here <link>. Anytime you are stuck, feel free to reach out via ``` (but with the actual link!) ########## File path: docs/source/index.rst ########## @@ -86,6 +86,7 @@ target environment.** :caption: Development developers/contributing + developers/guide/introduction Review comment: Just thinking - given most of the content is still to be written, perhaps we could look to merge this PR now, but add the content to the index later? ########## File path: docs/source/developers/guide/introduction.rst ########## @@ -0,0 +1,154 @@ +.. Licensed to the Apache Software Foundation (ASF) under one +.. or more contributor license agreements. See the NOTICE file +.. distributed with this work for additional information +.. regarding copyright ownership. The ASF licenses this file +.. to you under the Apache License, Version 2.0 (the +.. "License"); you may not use this file except in compliance +.. with the License. You may obtain a copy of the License at + +.. http://www.apache.org/licenses/LICENSE-2.0 + +.. Unless required by applicable law or agreed to in writing, +.. software distributed under the License is distributed on an +.. "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +.. KIND, either express or implied. See the License for the +.. specific language governing permissions and limitations +.. under the License. + + +.. SCOPE OF THIS SECTION +.. Make an introduction to the Guide for New Contributors. +.. Add an introduction to the project, why to get involved +.. and a quick checklist of the contributing process. +.. Add the Table of Contents. All detailed explanations +.. should be added as a link in the content. + + +.. _introduction: + +*********************** +New Contributor's Guide +*********************** + +This guide is meant to be a resource for contributing to +`Arrow <https://arrow.apache.org>`_ for new contributors. + +No matter what your current skills are you can try and make +your first time contribution to Arrow. + +Starting to contribute to a project like Apache Arrow can be +intimidating. Taking small steps will help making this tack +easier. + + +Why contribute to Arrow? +======================== +There can be various reasons why someone would want to contribute +to Arrow: + +* You find the project interesting and would like to try making + a contribution to learn more about the library and grow your skills. + +* You use Arrow in the project you are working on and you would like + to implement a new feature. + +Read more about the project in the :ref:`architectural_overview` section. + +Quick Reference +=============== + +Here are the basic steps needed to get set up and contribute to Arrow. +This is meant as a checklist and also to have an overall picture. Review comment: ```suggestion This is meant both as a checklist and also to provide an overall picture of the process. ``` ########## File path: docs/source/developers/guide/introduction.rst ########## @@ -0,0 +1,154 @@ +.. Licensed to the Apache Software Foundation (ASF) under one +.. or more contributor license agreements. See the NOTICE file +.. distributed with this work for additional information +.. regarding copyright ownership. The ASF licenses this file +.. to you under the Apache License, Version 2.0 (the +.. "License"); you may not use this file except in compliance +.. with the License. You may obtain a copy of the License at + +.. http://www.apache.org/licenses/LICENSE-2.0 + +.. Unless required by applicable law or agreed to in writing, +.. software distributed under the License is distributed on an +.. "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +.. KIND, either express or implied. See the License for the +.. specific language governing permissions and limitations +.. under the License. + + +.. SCOPE OF THIS SECTION +.. Make an introduction to the Guide for New Contributors. +.. Add an introduction to the project, why to get involved +.. and a quick checklist of the contributing process. +.. Add the Table of Contents. All detailed explanations +.. should be added as a link in the content. + + +.. _introduction: + +*********************** +New Contributor's Guide +*********************** + +This guide is meant to be a resource for contributing to +`Arrow <https://arrow.apache.org>`_ for new contributors. + +No matter what your current skills are you can try and make +your first time contribution to Arrow. + +Starting to contribute to a project like Apache Arrow can be +intimidating. Taking small steps will help making this tack Review comment: ```suggestion intimidating. Taking small steps will make this task ``` ########## File path: docs/source/developers/guide/communication.rst ########## @@ -0,0 +1,133 @@ +.. Licensed to the Apache Software Foundation (ASF) under one +.. or more contributor license agreements. See the NOTICE file +.. distributed with this work for additional information +.. regarding copyright ownership. The ASF licenses this file +.. to you under the Apache License, Version 2.0 (the +.. "License"); you may not use this file except in compliance +.. with the License. You may obtain a copy of the License at + +.. http://www.apache.org/licenses/LICENSE-2.0 + +.. Unless required by applicable law or agreed to in writing, +.. software distributed under the License is distributed on an +.. "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +.. KIND, either express or implied. See the License for the +.. specific language governing permissions and limitations +.. under the License. + + +.. SCOPE OF THIS SECTION +.. Present Arrow developers to the general public to make +.. the barrier of contributing lower as new contributors will +.. have a feeling of joint work and possible help. Add ways +.. of communication and add description of what is expected. +.. Also add a link to other resources. + + +.. _communication: + +************* +Communication +************* + +**About the contributors** + +The group of contributors is full of experts, software engineers and core +developers but also full of users, learners and enthusiasts that love doing +what we do and we want to spread this enthusiasm to you also. + +We all have silly questions and we all need help lots of times. +We encourage you to be open to communication and we will help as much as +we can. + +Due to the scale of the project which includes many languages, everybody +contributing will be faced with new things needed to be learned. Even the most +seasoned C++ developer will need to ask basic questions about R for example. + +When communicating, it's important you mark your communication with appropriate +tags ([C++], [R], [Ruby] etc.) so it gets noticed by the right people. + +Where to get help 👋 +==================== + +For any question you may have or problems you are facing you can write to +user or development :ref:`mailing_list` or you can create an issue on +:ref:`github`. + +For searching through the issues, reporting bugs and creating feature +requests or proposals you can use :ref:`jira` issue tracker. + +.. _jira: + +JIRA +~~~~ + +When to use JIRA? + +- If you want to **report a bug**. +- If you want to **propose a new feature**. +- If you want to **propose a bigger change in the documentation**. + +In these cases you can create a JIRA issue and connect with other +contributors in the issue comments. It is good to mention the +way you are planning to solve the issue and have one of the Arrow +developers agree with your basic proposal for fixing it. Better +to ask before you spend too much of your time on something that we +might think is not a good idea. + +.. seealso:: + How to create a JIRA issue. See `Tips for using JIRA <https://arrow.apache.org/docs/developers/contributing.html#tips-for-using-jira/>`_. + +- If you want to **solve an issue that is already in JIRA**, you should + connect with other contributors in the issue comments. + +JIRA is used to discuss the problem before a Pull Request is possibly made +(how to start, where to search for the solution, etc..). + +.. _github: + +GitHub +~~~~~~ + +Further options of communicating are provided through GitHub where the project +is hosted. What we use are GitGub Issues and Pull Requests. + +When to use GitHub? + +- If you have **a problem with building** one of the Arrow libraries, you can + create an issue on GitHub and discuss the possible solution (or write to the + user mailing list). + + Making an issue about things you are not sure about may feel intimidating, + but it is also useful for others and the project. + + .. note:: + Make sure to add which operating system and Arrow version you are using in the + ticket description plus the debug information/error. + +- If you have **a new feature already written**, you can create a Pull Request after + creating a JIRA ticket and mentioning the way you plan to implement it. +- GitHub is also used to discuss your work after the **Pull Request** is made. + +.. _mailing_list: + +Mailing List +~~~~~~~~~~~~~~~~~~~~~~~~~ + +You can subscribe to the **user** or **development** mailing list and browse for +previous topics or ask questions. Whereas discussion on GitHub and JIRA +only notifies people who have subscribed to that particular Pull Request or ticket, +the mailing list allows you to broadcast to all users or developers. Use these when +you want to get feedback or answers from a wider audience. + +There is also a **biweekly developers sync call** that anyone is welcome to join. +It is announced on the development mailing list together with the link to join. + +.. seealso:: + Link to subscribe to the mailing lists and find more info `can be found here <https://arrow.apache.org/community/>`_. Review comment: ```suggestion More information and links for subscribing to the mailing lists `can be found here <https://arrow.apache.org/community/>`_. ``` ########## File path: docs/source/developers/guide/introduction.rst ########## @@ -0,0 +1,154 @@ +.. Licensed to the Apache Software Foundation (ASF) under one +.. or more contributor license agreements. See the NOTICE file +.. distributed with this work for additional information +.. regarding copyright ownership. The ASF licenses this file +.. to you under the Apache License, Version 2.0 (the +.. "License"); you may not use this file except in compliance +.. with the License. You may obtain a copy of the License at + +.. http://www.apache.org/licenses/LICENSE-2.0 + +.. Unless required by applicable law or agreed to in writing, +.. software distributed under the License is distributed on an +.. "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +.. KIND, either express or implied. See the License for the +.. specific language governing permissions and limitations +.. under the License. + + +.. SCOPE OF THIS SECTION +.. Make an introduction to the Guide for New Contributors. +.. Add an introduction to the project, why to get involved +.. and a quick checklist of the contributing process. +.. Add the Table of Contents. All detailed explanations +.. should be added as a link in the content. + + +.. _introduction: + +*********************** +New Contributor's Guide +*********************** + +This guide is meant to be a resource for contributing to +`Arrow <https://arrow.apache.org>`_ for new contributors. + +No matter what your current skills are you can try and make +your first time contribution to Arrow. + +Starting to contribute to a project like Apache Arrow can be +intimidating. Taking small steps will help making this tack +easier. + + +Why contribute to Arrow? +======================== +There can be various reasons why someone would want to contribute +to Arrow: + +* You find the project interesting and would like to try making + a contribution to learn more about the library and grow your skills. + +* You use Arrow in the project you are working on and you would like + to implement a new feature. + +Read more about the project in the :ref:`architectural_overview` section. + +Quick Reference +=============== + +Here are the basic steps needed to get set up and contribute to Arrow. +This is meant as a checklist and also to have an overall picture. + +For complete instructions please follow :ref:`step_by_step` (a +step-by-step guide) or R and Python :ref:`tutorial-index` for an example +of adding a basic feature. + + +#. **Install and set up Git, fork the Arrow repository** + + See detailed instructions on how to :ref:`set-up` Git and fork the + Arrow repository. + +#. **Build Arrow** + + Arrow libraries include a wide range of functionalities and may require + the installation of third-party packages, depending on which build + options and components you enable. For example, the C++ build guide + has suggestions for whenever you are experiencing difficulties, be sure + to read them. Anytime you are stuck, feel free to reach out via + appropriate :ref:`communication` channel. + + See a short description about the building process of + :ref:`PyArrow or R-Arrow<build-arrow>` or go straight to detailed + instructions on how to build one of Arrow libraries in the + `documentation <https://arrow.apache.org/docs/>`_ . + +#. **Run the tests** + + Run the tests from a terminal for Python + + .. code-block:: + + $ pytest pyarrow + + or in R console for R + + .. code-block:: R + + devtools::test() + + See also the section on :ref:`testing`. + +#. **Find an issue (if needed), create a new branch and work on the problem** + + **Finding an issue** + + You can have a new bug or a new feature you want to implement. But if you + don't and you need an issue to work on you may need help finding it. Read Review comment: ```suggestion don't and you need an issue to work on, then you may need help finding it. Read ``` ########## File path: docs/source/developers/guide/introduction.rst ########## @@ -0,0 +1,154 @@ +.. Licensed to the Apache Software Foundation (ASF) under one +.. or more contributor license agreements. See the NOTICE file +.. distributed with this work for additional information +.. regarding copyright ownership. The ASF licenses this file +.. to you under the Apache License, Version 2.0 (the +.. "License"); you may not use this file except in compliance +.. with the License. You may obtain a copy of the License at + +.. http://www.apache.org/licenses/LICENSE-2.0 + +.. Unless required by applicable law or agreed to in writing, +.. software distributed under the License is distributed on an +.. "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +.. KIND, either express or implied. See the License for the +.. specific language governing permissions and limitations +.. under the License. + + +.. SCOPE OF THIS SECTION +.. Make an introduction to the Guide for New Contributors. +.. Add an introduction to the project, why to get involved +.. and a quick checklist of the contributing process. +.. Add the Table of Contents. All detailed explanations +.. should be added as a link in the content. + + +.. _introduction: + +*********************** +New Contributor's Guide +*********************** + +This guide is meant to be a resource for contributing to +`Arrow <https://arrow.apache.org>`_ for new contributors. + +No matter what your current skills are you can try and make +your first time contribution to Arrow. + +Starting to contribute to a project like Apache Arrow can be +intimidating. Taking small steps will help making this tack +easier. + + +Why contribute to Arrow? +======================== +There can be various reasons why someone would want to contribute +to Arrow: + +* You find the project interesting and would like to try making + a contribution to learn more about the library and grow your skills. + +* You use Arrow in the project you are working on and you would like + to implement a new feature. + +Read more about the project in the :ref:`architectural_overview` section. + +Quick Reference +=============== + +Here are the basic steps needed to get set up and contribute to Arrow. +This is meant as a checklist and also to have an overall picture. + +For complete instructions please follow :ref:`step_by_step` (a +step-by-step guide) or R and Python :ref:`tutorial-index` for an example +of adding a basic feature. + + +#. **Install and set up Git, fork the Arrow repository** + + See detailed instructions on how to :ref:`set-up` Git and fork the + Arrow repository. + +#. **Build Arrow** + + Arrow libraries include a wide range of functionalities and may require + the installation of third-party packages, depending on which build + options and components you enable. For example, the C++ build guide + has suggestions for whenever you are experiencing difficulties, be sure + to read them. Anytime you are stuck, feel free to reach out via + appropriate :ref:`communication` channel. + + See a short description about the building process of + :ref:`PyArrow or R-Arrow<build-arrow>` or go straight to detailed + instructions on how to build one of Arrow libraries in the + `documentation <https://arrow.apache.org/docs/>`_ . + +#. **Run the tests** + + Run the tests from a terminal for Python + + .. code-block:: + + $ pytest pyarrow + + or in R console for R + + .. code-block:: R + + devtools::test() + + See also the section on :ref:`testing`. + +#. **Find an issue (if needed), create a new branch and work on the problem** + + **Finding an issue** + + You can have a new bug or a new feature you want to implement. But if you + don't and you need an issue to work on you may need help finding it. Read + through the :ref:`finding-issues` section to get some ideas. + + **Finding your way through the project** + + The first step when starting a new project is the hardest. We wrote some + help guides that we used when we were looking for solutions and we hope + they will help. + + .. TODO: Read through :ref:`solving` section. + + **Communication** + + Communication is very important. You may need some help solving problems + you encounter on the way (happening to developers all the time). Also, + if you have a JIRA issue you want to solve it is advisable to let the team + know you are working on it and may need some help. Review comment: ```suggestion Communication is very important. You may need some help solving problems you encounter on the way (this happens to developers all the time). Also, if you have a JIRA issue you want to solve, then it is advisable to let the team know you are working on it and may need some help. ``` ########## File path: docs/source/developers/guide/introduction.rst ########## @@ -0,0 +1,154 @@ +.. Licensed to the Apache Software Foundation (ASF) under one +.. or more contributor license agreements. See the NOTICE file +.. distributed with this work for additional information +.. regarding copyright ownership. The ASF licenses this file +.. to you under the Apache License, Version 2.0 (the +.. "License"); you may not use this file except in compliance +.. with the License. You may obtain a copy of the License at + +.. http://www.apache.org/licenses/LICENSE-2.0 + +.. Unless required by applicable law or agreed to in writing, +.. software distributed under the License is distributed on an +.. "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +.. KIND, either express or implied. See the License for the +.. specific language governing permissions and limitations +.. under the License. + + +.. SCOPE OF THIS SECTION +.. Make an introduction to the Guide for New Contributors. +.. Add an introduction to the project, why to get involved +.. and a quick checklist of the contributing process. +.. Add the Table of Contents. All detailed explanations +.. should be added as a link in the content. + + +.. _introduction: + +*********************** +New Contributor's Guide +*********************** + +This guide is meant to be a resource for contributing to +`Arrow <https://arrow.apache.org>`_ for new contributors. + +No matter what your current skills are you can try and make +your first time contribution to Arrow. + +Starting to contribute to a project like Apache Arrow can be +intimidating. Taking small steps will help making this tack +easier. + + +Why contribute to Arrow? +======================== +There can be various reasons why someone would want to contribute +to Arrow: Review comment: ```suggestion There can be various reasons why you might want to contribute to Arrow: ``` ########## File path: docs/source/developers/guide/introduction.rst ########## @@ -0,0 +1,154 @@ +.. Licensed to the Apache Software Foundation (ASF) under one +.. or more contributor license agreements. See the NOTICE file +.. distributed with this work for additional information +.. regarding copyright ownership. The ASF licenses this file +.. to you under the Apache License, Version 2.0 (the +.. "License"); you may not use this file except in compliance +.. with the License. You may obtain a copy of the License at + +.. http://www.apache.org/licenses/LICENSE-2.0 + +.. Unless required by applicable law or agreed to in writing, +.. software distributed under the License is distributed on an +.. "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +.. KIND, either express or implied. See the License for the +.. specific language governing permissions and limitations +.. under the License. + + +.. SCOPE OF THIS SECTION +.. Make an introduction to the Guide for New Contributors. +.. Add an introduction to the project, why to get involved +.. and a quick checklist of the contributing process. +.. Add the Table of Contents. All detailed explanations +.. should be added as a link in the content. + + +.. _introduction: + +*********************** +New Contributor's Guide +*********************** + +This guide is meant to be a resource for contributing to +`Arrow <https://arrow.apache.org>`_ for new contributors. + +No matter what your current skills are you can try and make +your first time contribution to Arrow. + +Starting to contribute to a project like Apache Arrow can be +intimidating. Taking small steps will help making this tack +easier. + + +Why contribute to Arrow? +======================== +There can be various reasons why someone would want to contribute +to Arrow: + +* You find the project interesting and would like to try making + a contribution to learn more about the library and grow your skills. + +* You use Arrow in the project you are working on and you would like + to implement a new feature. + +Read more about the project in the :ref:`architectural_overview` section. + +Quick Reference +=============== + +Here are the basic steps needed to get set up and contribute to Arrow. +This is meant as a checklist and also to have an overall picture. + +For complete instructions please follow :ref:`step_by_step` (a +step-by-step guide) or R and Python :ref:`tutorial-index` for an example +of adding a basic feature. + + +#. **Install and set up Git, fork the Arrow repository** Review comment: ```suggestion #. **Install and set up Git, and fork the Arrow repository** ``` ########## File path: docs/source/developers/guide/introduction.rst ########## @@ -0,0 +1,154 @@ +.. Licensed to the Apache Software Foundation (ASF) under one +.. or more contributor license agreements. See the NOTICE file +.. distributed with this work for additional information +.. regarding copyright ownership. The ASF licenses this file +.. to you under the Apache License, Version 2.0 (the +.. "License"); you may not use this file except in compliance +.. with the License. You may obtain a copy of the License at + +.. http://www.apache.org/licenses/LICENSE-2.0 + +.. Unless required by applicable law or agreed to in writing, +.. software distributed under the License is distributed on an +.. "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +.. KIND, either express or implied. See the License for the +.. specific language governing permissions and limitations +.. under the License. + + +.. SCOPE OF THIS SECTION +.. Make an introduction to the Guide for New Contributors. +.. Add an introduction to the project, why to get involved +.. and a quick checklist of the contributing process. +.. Add the Table of Contents. All detailed explanations +.. should be added as a link in the content. + + +.. _introduction: + +*********************** +New Contributor's Guide +*********************** + +This guide is meant to be a resource for contributing to +`Arrow <https://arrow.apache.org>`_ for new contributors. + +No matter what your current skills are you can try and make +your first time contribution to Arrow. + +Starting to contribute to a project like Apache Arrow can be +intimidating. Taking small steps will help making this tack +easier. + + +Why contribute to Arrow? +======================== +There can be various reasons why someone would want to contribute +to Arrow: + +* You find the project interesting and would like to try making + a contribution to learn more about the library and grow your skills. + +* You use Arrow in the project you are working on and you would like + to implement a new feature. + +Read more about the project in the :ref:`architectural_overview` section. + +Quick Reference +=============== + +Here are the basic steps needed to get set up and contribute to Arrow. +This is meant as a checklist and also to have an overall picture. + +For complete instructions please follow :ref:`step_by_step` (a +step-by-step guide) or R and Python :ref:`tutorial-index` for an example +of adding a basic feature. + + +#. **Install and set up Git, fork the Arrow repository** + + See detailed instructions on how to :ref:`set-up` Git and fork the + Arrow repository. + +#. **Build Arrow** + + Arrow libraries include a wide range of functionalities and may require + the installation of third-party packages, depending on which build + options and components you enable. For example, the C++ build guide + has suggestions for whenever you are experiencing difficulties, be sure + to read them. Anytime you are stuck, feel free to reach out via + appropriate :ref:`communication` channel. + + See a short description about the building process of + :ref:`PyArrow or R-Arrow<build-arrow>` or go straight to detailed + instructions on how to build one of Arrow libraries in the + `documentation <https://arrow.apache.org/docs/>`_ . + +#. **Run the tests** + + Run the tests from a terminal for Python + + .. code-block:: + + $ pytest pyarrow + + or in R console for R + + .. code-block:: R + + devtools::test() + + See also the section on :ref:`testing`. + +#. **Find an issue (if needed), create a new branch and work on the problem** + + **Finding an issue** + + You can have a new bug or a new feature you want to implement. But if you + don't and you need an issue to work on you may need help finding it. Read + through the :ref:`finding-issues` section to get some ideas. + + **Finding your way through the project** + + The first step when starting a new project is the hardest. We wrote some + help guides that we used when we were looking for solutions and we hope + they will help. Review comment: ```suggestion The first step when starting a new project is the hardest and so we've wrote some guides to help you with this. ``` -- 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-unsubscr...@arrow.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
