jorisvandenbossche commented on a change in pull request #11677: URL: https://github.com/apache/arrow/pull/11677#discussion_r754334256
########## File path: docs/source/developers/guide/communication.rst ########## @@ -0,0 +1,77 @@ +.. 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. + +.. _communication: + +************* +Communication +************* + +**About the team** + +The team 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. + +Where to get help 👋 +==================== + +Jira +~~~~~~~~ + +Thhe most used way is to communicate through Jira. +When to use this option? + +- **Want to solve a bug** → post an issue on Jira and connect with the team + in the comments. Review comment: If you want to _solve_ a bug, you might typically look for an existing JIRA, in which case "post an issue on Jira" -> "post a comment on Jira"? (edit: I see now this is the next bullet point ..) Or could also rephrase as "Want to report a bug" ########## File path: docs/source/developers/guide/introduction.rst ########## @@ -0,0 +1,135 @@ +.. 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. + +.. _introduction: + +********************** +New Contributor's Guide Review comment: I think the main page for which we need to look out in not duplicating too much is the current "Contributing to Apache Arrow" first page of the developer section (https://arrow.apache.org/docs/developers/contributing.html), since this also has eg a section on communication. For the name of the guide, it could also be something like "Getting started with contributing to Arrow" (or a shorter version) ########## File path: docs/source/developers/guide/introduction.rst ########## @@ -0,0 +1,135 @@ +.. 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. + +.. _introduction: + +********************** +New Contributor's Guide +********************** + +This guide is meant to be a resource for contributing to +`Arrow <https://arrow.apache.org//>`_ for new contributors. + +Starting to contribute to a project like Apache Arrow can look +scary if not completely impossible. But we can reassure you it is +not. What we have to do is to take small steps. + + +Why contribute to Arrow? +======================== +There can be various reasons why someone would want to contribute +to Arrow and all of them are valid! + +* You find the project interesting and would like to give it a go, + learn and grow. + +* You use Arrow in the project you are working on and it would be + great to make some quick fixes by yourself + +Read more about the project in the :ref:`about_arrow` 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. + +#. **Building Arrow** + + This can be quite easy or a real blocker. Be prepared to dig through the + additional flags for cmake in the C++ build guide and read the doc carefully + to not miss any suggestions already given there. Anytime you are stuck, + reach out to us via appropriate :ref:`communication` channel. + + See detailed instructions on how to :ref:`build-arrow`. + +#. **Run the tests** + + Run the tests from a terminal for Python Review comment: > I did, but as there is only one line per language currently, it took much more space as it does now. I think it is better to use tabs when there are more lines of code and the visibility gets improved with using tabs. Did you mean that it takes more space in the rst code here? I think that's fine (I agree sphinx-tabs can be quite verbose), as the majority will look at the built docs online, and there it will not take much more space by having the tabs (certainly if we would also want to add other languages here as well). -- 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
