Getting Started

Remember that the complete setup instructions are found in the Contribution Guide. The following steps are in case you have difficulties following the Contribution Guide.

Setup Tips for Prerequisites

The following steps can help to set up the environment listed in the Contribution guide

- A GitHub account.
- A Linux, macOS, or Microsoft Windows development environment
- Java JDK 8 installed
- [Docker](https://www.docker.com/) installed for some tasks including building worker containers and testing this website
changes locally.
- For SDK Development:
- [Go](https://golang.org) 1.20 or later installed for Go SDK development
- Python 3.7, and 3.8, and 3.11. Yes, you need all three 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).

For MacOS

Install Java 8, Go 1.20, pyenv and Docker using homebrew.
1. Check the following tutorial How to install Java 8 on Mac.
Use pyenv to install the python versions, 3.7, 3.8, 3.11.
Use pip (installed when installing pyenv) to install setuptools, virtualenv, and tox.
Clone the apache beam project from https://github.com/apache/beam
using main branch.
1. cd into the /beam root project
Execute the following commands:
```
./gradlew projects
```
```
./gradlew tasks
```

To make sure Java environment is correctly installed, execute:

./gradlew -p sdks/java/io/cassandra check

./gradlew -p runners/flink check

For Windows

(in construction)

https://github.com/pyenv-win/pyenv-win

Content

See child pages in the sidebar:

Beam Jira Beginner's Guide

Beam Testing Tools FAQ

CI Security Model

Commiters FAQ

Contribution Testing Guide

Contributor FAQ

Eclipse Tips

Git Tips

Spotless pre-commit

Go Tips

Supporting Streaming in the Go SDK

Gradle Tips

Java Tips

Jenkins Tips

Jira Dashboards

Multi-language Pipelines Tips

Space shortcuts

Page tree