跳到正文
cccskills
免费在 GitHub 公开

contributing

Navigate Apache Beam contributions from finding an issue to submitting a pull request, a proposed code change, and responding to reviews. Covers environment setup, tests, formatting, licensing requirements, and closer evaluation of changes to core components.

中文简介正在准备中。当前显示英语简介。

原文查看原文说明

Guides the contribution workflow for Apache Beam, including creating PRs, issue management, code review process, release cycles, and rigorous evaluation rules for high-risk core component changes. Use when contributing code, creating PRs, or modifying core Beam components.

查看安装方法

适用场景

  • Prepare a first Apache Beam contribution
  • Organize a pull request and its related issue
  • Check tests and formatting before submission
  • Review risks in core component changes

包含的文件(1)

  • SKILL.md5.7 KB

SKILL.md(原文)

安装前可以查看交给 AI 代理的指令内容。

Contributing to Apache Beam

Getting Started

Prerequisites

  • GitHub account
  • Java JDK 11 (preferred, or 8, 17, 21)
  • Latest Go 1.x
  • Docker
  • Python (any supported version for manual testing, all versions for running test suites)
  • For large contributions: signed ICLA to Apache Software Foundation

Environment Setup Options

Local Setup (automated)

./local-env-setup.sh

Docker-based Setup

./start-build-env.sh

Contribution Workflow

1. Find or Create an Issue

2. Claim the Issue

.take-issue    # Assigns issue to you
.free-issue    # Unassigns issue from you
.close-issue   # Closes the issue

3. For Large Changes

4. Make Your Changes

  • Every source file needs Apache license header
  • New dependencies must have Apache-compatible open source licenses
  • Add unit tests for your changes
  • Document public-facing APIs in a standard way (Javadoc, docstrings/pydoc).
    • Documentation should be user-friendly, informative.
    • Implementation details belong in inline code comments.
  • Use descriptive commit messages

Working on Core Components (High Risk — Heightened Scrutiny)

AGENT DIRECTIVE: modification to Core Components carries an inherently elevated risk of silent regression across distributed runners. Refer to .github/autolabeler.yml under the "core" label for the authoritative list of core component paths (including sdks/java/core, runners/core-*, model, sdks/python/apache_beam/transforms|coders, sdks/go/pkg/beam/core, FileIO, and GCS). If you are an AI agent modifying files matched by these paths, evaluate your changes with scrutiny.

5. Create Pull Request

  • Link to the issue in PR description
  • Pre-commit tests run automatically
  • If tests fail unrelated to your change, comment: retest this please

6. Code Review

  • Reviewers are auto-assigned within a few hours
  • Use R: @username to request specific reviewer
  • No response in 3 days? Email dev@beam.apache.org

Code Review Best Practices

For Authors

  • Provide context in issue and PR description
  • Avoid huge mega-changes
  • Add follow-up changes as "fixup" commits (don't squash until approved)
  • Squash fixup commits after approval

For Reviewers

  • PRs can only be merged by Beam committers
  • PRs with the core label touch foundational Beam semantics or common code paths; review with extra scrutiny for non-obvious failure modes, edge case, and performance regressions

Testing Workflows

Pre-commit Tests

Run automatically on PRs. To run locally:

./gradlew javaPreCommit      # Java
./gradlew :sdks:python:test  # Python
./gradlew :sdks:go:test      # Go

Post-commit Tests

Run after merge. Trigger phrases in PR comments start specific test suites. See trigger phrase catalog.

Formatting

Java

./gradlew spotlessApply

Python

# Uses yapf, isort, pylint
pre-commit run --all-files

CHANGES.md

./gradlew formatChanges

Release Cycle

  • Minor releases every 6 weeks
  • Check release calendar
  • Changes must be in master before release branch is cut

Stale PRs

  • PRs become stale after 60 days of author inactivity
  • Community will close stale PRs
  • Authors can reopen closed PRs

Key Resources

Communication

评价

还没有评价。欢迎分享你的使用感受。

评论

无需登录即可发表。欢迎分享使用感受、提问,或说明在哪些环境下无法运行。

还没有评论。来写第一条吧。

提交后会立即公开。请勿填写邮箱、电话等个人信息。URL 最多 2 个。

0 / 1000 字

此表单受 reCAPTCHA 保护,适用 Google 的隐私权政策和服务条款。

同一仓库的技能

Guides adding metadata, extra information attached to data elements, to Apache Beam's WindowedValue. Maps the changes needed across serialization, storage, processing, and runner interfaces so new fields remain available during pipeline execution.

中文简介正在准备中。当前显示英语简介。

  • Adding trace context or drain flags to WindowedValue
  • Checking metadata preservation through Windmill storage
  • Reviewing propagation through grouping and timers
apache/beam86862026年10月19日 更新

Learn Apache Beam's core concepts through Java and Python examples. Understand distributed datasets, processing steps, pipeline execution, and time windows, with guidance on aggregation, late data, error handling, and sharing processing steps across languages.

中文简介正在准备中。当前显示英语简介。

  • Learn how Pipeline, PCollection, and PTransform fit together
  • Understand grouping, aggregation, merging, and splitting
  • Study time windows, output timing, and late data
apache/beam86862026年10月19日 更新

ci-cd

免费

Helps investigate and modify Apache Beam's automated build and test workflows in GitHub Actions. Explains workflow types, failure logs, targeted reruns, local reproduction, and the cloud credentials needed for workflows that access GCP.

中文简介正在准备中。当前显示英语简介。

  • Investigating failed checks on a pull request
  • Rerunning a specific test workflow
  • Reproducing CI test commands locally
apache/beam86862026年10月19日 更新

Build Apache Beam connectors that read and write external data. This guide covers Java implementation, schema support for structured records, access from Python and Go, Managed API integration, and testing.

中文简介正在准备中。当前显示英语简介。

  • Add a connector for an external data system
  • Make a Java connector available to Python and Go
  • Integrate a connector with Beam YAML and the Managed API
apache/beam86862026年10月19日 更新

Build and test Apache Beam with Gradle, the system that manages its project tasks. Find relevant configuration files, inspect library dependencies, run formatting checks, publish locally, and investigate build failures.

中文简介正在准备中。当前显示英语简介。

  • Build or test a specific Apache Beam module
  • Inspect library dependencies and version conflicts
  • Run formatting and pre-commit checks
apache/beam86862026年10月19日 更新

Work with Apache Beam I/O connectors, components that read and write external data. Get guidance on connector usage, unit and integration tests, troubleshooting data connections, and the basic structure of new connectors.

中文简介正在准备中。当前显示英语简介。

  • Add BigQuery or Kafka reads and writes to a pipeline
  • Run unit and integration tests for connectors
  • Investigate data source or destination issues
apache/beam86862026年10月19日 更新

查看 apache 的全部技能

报告此技能的问题