apache / apache/arrow

[Archery] Add documentation for local development in archery/crossbow

Open
#31,575 1 comment 0 reactions 0 assignees View on GitHub
Component: Developer Tools Status: needs champion Type: enhancement
Dominant language
C++
Stars
17.1k
Forks
4.3k
Avg merge
3d 18h
Merged PRs (30d)
91

Description

When working on this fix for archery crossbow https://issues.apache.org/jira/browse/ARROW-16165 I have realized that there is some lack of documentation for development on archery.

Explaining how to set up the environment, install dependencies, run tests, etcetera should be documented.

**Reporter**: [Raúl Cumplido](https://issues.apache.org/jira/browse/ARROW-16171) / @raulcd

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

Contributor guide

Open the contributing guide

Research direction

Start by locating the archery/crossbow development documentation and the existing setup, dependency-installation, and test entry points. Document how to prepare the environment, install dependencies, and run tests; the work is done when a developer can follow the documentation to set up and test archery/crossbow locally.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.