Skip to content

Commit

Permalink
[BEAM-8956] Begin unifying contributor instructions into a single loc…
Browse files Browse the repository at this point in the history
…ation
  • Loading branch information
elharo authored and iemejia committed Jan 13, 2020
1 parent 33d52b2 commit 420a6e8
Show file tree
Hide file tree
Showing 3 changed files with 34 additions and 50 deletions.
29 changes: 0 additions & 29 deletions CONTRIBUTING.md

This file was deleted.

23 changes: 6 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,20 +83,8 @@ Have ideas for new Runners? See the [JIRA](https://issues.apache.org/jira/issues

## Getting Started

Please refer to the Quickstart[[Java](https://beam.apache.org/get-started/quickstart-java), [Python](https://beam.apache.org/get-started/quickstart-py), [Go](https://beam.apache.org/get-started/quickstart-go)] available on our website.

If you'd like to build and install the whole project from the source distribution, you may need some additional tools installed
in your system. In a Debian-based distribution:

```
sudo apt-get install \
openjdk-8-jdk \
python-setuptools \
python-pip \
virtualenv
```

Then please use the standard `./gradlew build` command.
To learn how to write Beam pipelines, read the Quickstart for [[Java](https://beam.apache.org/get-started/quickstart-java), [Python](https://beam.apache.org/get-started/quickstart-py), or
[Go](https://beam.apache.org/get-started/quickstart-go)] available on our website.

## Contact Us

Expand All @@ -106,11 +94,12 @@ To get involved in Apache Beam:
* [Subscribe](mailto:[email protected]) or [mail](mailto:[email protected]) the [[email protected]](http:https://mail-archives.apache.org/mod_mbox/beam-dev/) list.
* Report issues on [JIRA](https://issues.apache.org/jira/browse/BEAM).

We also have a [contributor's guide](https://beam.apache.org/contribute/contribution-guide/).
Instructions for building and testing Beam itself
are in the [contribution guide](https://beam.apache.org/contribute/).

## More Information

* [Apache Beam](http:https://beam.apache.org)
* [Overview](http:https://beam.apache.org/use/beam-overview/)
* [Apache Beam](https:https://beam.apache.org)
* [Overview](https:https://beam.apache.org/use/beam-overview/)
* Quickstart: [Java](https://beam.apache.org/get-started/quickstart-java), [Python](https://beam.apache.org/get-started/quickstart-py), [Go](https://beam.apache.org/get-started/quickstart-go)
* [Community metrics](https://s.apache.org/beam-community-metrics)
32 changes: 28 additions & 4 deletions website/src/contribute/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,14 +67,38 @@ To contribute code, you need

- a GitHub account
- a Linux, macOS, or Microsoft Windows development environment with Java JDK 8 installed
- [Docker](https://www.docker.com/) installed for some tasks including building worker containers and testing website
- [Docker](https://www.docker.com/) installed for some tasks including building worker containers and testing this website
changes locally
- [Go](https://golang.org) 1.10 or later installed for Go SDK development
- Python, virtualenv, and tox installed for Python SDK development
- [Go](https://golang.org) 1.12 or later installed for Go SDK development
- Python 2.7, 3.5, 3.6, and 3.7. Yes, you need all four versions installed.
- pip, setuptools, virtualenv, and tox installed for Python development
- for large contributions, a signed [Individual Contributor License
Agreement](https://www.apache.org/licenses/icla.pdf) (ICLA) to the Apache
Software Foundation (ASF).

To install these in a Debian-based distribution:

```
sudo apt-get install \
openjdk-8-jdk \
python-setuptools \
python-pip \
virtualenv \
tox \
docker-ce
```

You also need to [install Go](https://golang.org/doc/install]).

Once Go is installed, install goavro:

```
$ export GOPATH=`pwd`/sdks/go/examples/.gogradle/project_gopath
$ go get github.com/linkedin/goavro
```

gLinux users should configure their machines for sudoless Docker.

### Connect With the Beam community

1. Consider subscribing to the [dev@ mailing list]({{ site.baseurl}}/community/contact-us/), especially
Expand Down Expand Up @@ -182,7 +206,7 @@ To contribute code, you need
1. If you don't get any response in 3 business days, email the [dev@ mailing list]({{ site.baseurl }}/community/contact-us) to ask for someone to look at your pull
request.

### Make reviewer's job easier
### Make the reviewer's job easier

1. Provide context for your changes in the associated JIRA issue and/or PR description.

Expand Down

0 comments on commit 420a6e8

Please sign in to comment.