Google Git
Sign in
apache / beam / master / . / contributor-docs
tree: 444894e80421bc6d8fd576de442905ce8554c937 [path history] [tgz]
  1. discussion-docs/
  2. images/
  3. code-change-guide.md
  4. committer-guide.md
  5. committer-onboarding.md
  6. java-dependency-upgrades.md
  7. python-tips.md
  8. rc-testing-guide.md
  9. README.md
  10. release-guide.md
  11. updating-supported-python-versions.md
contributor-docs/README.md

Contributor Documentation

This directory contains documentation for contributors to the Apache Beam project.

Table of Contents

  • Code Change Guide: A guide for Beam users and developers on how to change, test, and build Beam code, including setting up Java and Python development environments.
  • Committer Guide: Guidelines for Beam committers regarding code review, pull request objectives, merging processes, and post-merge tasks.
  • Committer Onboarding: A checklist for new Beam committers to set up their accounts and permissions.
  • Java Dependency Upgrades: Instructions for upgrading Java dependencies in Beam, including running linkage checkers and verification tests.
  • Python Tips: Tips and instructions for developing the Python SDK, including environment setup, running tests, and handling dependencies.
  • RC Testing Guide: A guide for testing Beam Release Candidates (RCs) against downstream projects for Python, Java, and Go SDKs.
  • Release Guide: A comprehensive guide for the Release Manager on how to perform a Beam release, from preparation to promotion.
  • Updating Supported Python Versions: Instructions for adding support for new Python versions or removing support for end-of-life versions in Apache Beam.

Discussion Documents

The discussion-docs directory contains discussion documents and proposals that have been mailed to the dev@beam.apache.org mailing list, organized by year.

Confluence Wiki

The Confluence wiki for Apache Beam contains additional documentation and information for contributors. Some information may be out of date, but is still useful for reference.