apache / apache/beam

Contributing docs omit many steps

Open
#19,932 0 comments 0 reactions 0 assignees View on GitHub
bug P3 website
Dominant language
Java
Stars
8.7k
Forks
4.7k
Avg merge
1d 20h
Merged PRs (30d)
196

Description

So far I've noticed the following packages and tools that are not available by default on a Debian system, need to be installed to build and test beam, and are not yet mentioned in all our docs:

* tox
* Go
* Python (which versions?)
* Docker

There might be more. The docs such as README.md should be updated to include these. This covers README.md, CONTRIBUTING.md, https://cwiki.apache.org/confluence/display/BEAM/Contributor****FAQ, and https://beam.apache.org/contribute/

That we have four such docs is itself an issue. We should probably consolidate these.

Imported from Jira [BEAM-8798](https://issues.apache.org/jira/browse/BEAM-8798). Original Jira may contain additional context.
Reported by: elharo.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.