1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
|
.. 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.
.. highlight:: console
.. _developers:
Development
===========
Connection to the specific language development pages:
.. tab-set::
.. tab-item:: C++
* :ref:`cpp-development`
* :ref:`C++ Development Guidelines <development-cpp>`
* :ref:`building-arrow-cpp`
.. tab-item:: Java
* :doc:`java/index`
.. tab-item:: Python
* :ref:`python-development`
* :ref:`build_pyarrow`
* :ref:`develop_pyarrow`
.. tab-item:: R
* `Arrow R Package: Developer environment setup <https://arrow.apache.org/docs/dev/r/articles/developers/setup.html>`_
* `Arrow R Package: Common developer workflow tasks <https://arrow.apache.org/docs/dev/r/articles/developers/workflow.html>`_
.. tab-item:: Ruby
* `Red Arrow - Apache Arrow Ruby <https://github.com/apache/arrow/tree/main/ruby/red-arrow#development>`_
.. _contributing:
Contributing to Apache Arrow
============================
**Thanks for your interest in the Apache Arrow project.**
Arrow is a large project and may seem overwhelming when you're
first getting involved. Contributing code is great, but that's
probably not the first place to start. There are lots of ways to
make valuable contributions to the project and community.
This page provides some orientation for how to get involved. It also offers
some recommendations on how to get the best results when engaging with the
community.
Code of Conduct
---------------
All participation in the Apache Arrow project is governed by the ASF's
`Code of Conduct <https://www.apache.org/foundation/policies/conduct.html>`_.
.. grid:: 1 2 2 2
:gutter: 4
:padding: 2 2 0 0
:class-container: sd-text-center
.. grid-item-card:: Apache Arrow Community
:img-top: ./images/users-solid.svg
:class-card: contrib-card
:shadow: none
A good first step to getting involved in the Arrow project is to join
the mailing lists and participate in discussions where you can.
+++
.. button-link:: https://arrow.apache.org/community/
:click-parent:
:color: primary
:expand:
To Apache Arrow Community
.. grid-item-card:: Bug reports and feature requests
:img-top: ./images/bug-solid.svg
:class-card: contrib-card
:shadow: none
Alerting us to unexpected behavior and missing features, even
if you can't solve the problems yourself, help us understand
and prioritize work to improve the libraries.
+++
.. button-ref:: bug-reports
:ref-type: ref
:click-parent:
:color: primary
:expand:
To Bug reports and feature requests
.. dropdown:: Communicating through the mailing lists
:animate: fade-in-slide-down
:class-title: sd-fs-5
:class-container: sd-shadow-none
Projects in The Apache Software Foundation ("the ASF") use public, archived
mailing lists to create a public record of each project's development
activities and decision-making process.
While lacking the immediacy of chat or other forms of communication,
the mailing lists give participants the opportunity to slow down and be
thoughtful in their responses, and they help developers who are spread across
many timezones to participate more equally.
Read more on the `Apache Arrow Community <https://arrow.apache.org/community/>`_
page.
.. dropdown:: Improve documentation
:animate: fade-in-slide-down
:class-title: sd-fs-5
A great way to contribute to the project is to improve documentation. If you
found some docs to be incomplete or inaccurate, share your hard-earned knowledge
with the rest of the community.
Documentation improvements are also a great way to gain some experience with
our submission and review process, discussed below, without requiring a lot
of local development environment setup. In fact, many documentation-only changes
can be made directly in the GitHub web interface by clicking the "edit" button.
This will handle making a fork and a pull request for you.
* :ref:`documentation`
* :ref:`building-docs`
.. grid:: 1 2 2 2
:gutter: 4
:padding: 2 2 0 0
:class-container: sd-text-center
.. grid-item-card:: New Contributor's guide
:img-top: ./images/book-open-solid.svg
:class-card: contrib-card
First time contributing?
The New Contributor's Guide provides necessary information for
contributing to the Apache Arrow project.
+++
.. button-ref:: guide-introduction
:ref-type: ref
:click-parent:
:color: primary
:expand:
To the New Contributor's guide
.. grid-item-card:: Contributing Overview
:img-top: ./images/code-solid.svg
:class-card: contrib-card
A short overview of the contributing process we follow
and some additional information you might need if you are not
new to the contributing process in general.
+++
.. button-ref:: contrib-overview
:ref-type: ref
:click-parent:
:color: primary
:expand:
To Contributing overview
.. dropdown:: Continuous Integration
:animate: fade-in-slide-down
:class-title: sd-fs-5
:class-container: sd-shadow-none
Continuous Integration needs to run across different combinations of package managers, compilers, versions of multiple
software libraries, operating systems, and other potential sources of variation.
Read more on the :ref:`continuous_integration` page.
.. dropdown:: Benchmarks
:animate: fade-in-slide-down
:class-title: sd-fs-5
:class-container: sd-shadow-none
How to use the benchmark suite can be found on the :ref:`benchmarks` page.
.. dropdown:: Release Guide
:animate: fade-in-slide-down
:class-title: sd-fs-5
:class-container: sd-shadow-none
To learn about the detailed information on the steps followed to perform a release, see :ref:`release`.
.. dropdown:: Release Verification Process
:animate: fade-in-slide-down
:class-title: sd-fs-5
:class-container: sd-shadow-none
To learn how to verify a release, see :ref:`release_verification`.
.. toctree::
:maxdepth: 2
:hidden:
bug_reports
guide/index
overview
reviewing
cpp/index
java/index
python/index
continuous_integration/index
benchmarks
documentation
release
release_verification
|
