apache / apache/arrow

[Docs] Clarify processes for first-time contributors

Open
#32,712 3 comments 0 reactions 0 assignees View on GitHub
Component: C++ Component: Documentation Component: Go Component: Python Component: R Type: task
Dominant language
C++
Stars
17.1k
Forks
4.3k
Avg merge
3d 18h
Merged PRs (30d)
91

Description

Per [this discussion](https://lists.apache.org/thread/hycr4ghh7csspvm9jyffvqh8qo5koobg), improvements should be considered to reduce friction for first-time contributors through documentation of environment setup, CI checks, code review expectations, etc. Some of this exists scattered in various locations throughout documentation (e.g., language-specific development environments are documented), but it can be difficult to find. The [contributing page](https://arrow.apache.org/docs/developers/contributing.html) has some pointers at the bottom.

**Reporter**: [Todd Farmer](https://issues.apache.org/jira/browse/ARROW-17447) / @toddfarmer

**Note**: *This issue was originally created as [ARROW-17447](https://issues.apache.org/jira/browse/ARROW-17447). Please see the [migration documentation](https://github.com/apache/arrow/issues/14542) for further details.*

Contributor guide

Open the contributing guide

Research direction

Start with docs/developers/contributing.html and the linked discussion, then locate the scattered language-specific development-environment guidance and existing CI and review documentation. Done means first-time contributors can find consolidated, clear instructions for environment setup, CI checks, and code review expectations from the contributing page.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.