How do I install the Contributing skill?

Run npx skillmds@latest add tomevault-io/contributing in your terminal (requires Node.js), paste this page's agent-chat prompt into Claude, Cursor, or any MCP-connected agent, or download the SKILL.md file and copy it into your agent's skills directory.

Is Contributing safe to use?

This skill has not completed SkillMD's automated safety review yet. Independent scanners report: SkillSpector: PASS, Skill Scanner: PASS. SkillMD never runs a skill's scripts for you; review the SKILL.md before installing.

Which AI agents work with Contributing?

This skill is tagged as working with Claude Code, Claude.ai, OpenAI Codex. SKILL.md is an open format, so most agents that read a skills directory can load it too.

Is Contributing free to use?

Yes. Installing skills from SkillMD is free, and the skill stays under its author's original license.

Who published Contributing?

tomevault-io (@tomevault-io) published this skill. Their other Agent Skills are listed on their SkillMD profile.

Contributing by tomevault-io — Agent Skill

Name: Contributing
Author: tomevault-io

Contributing

Guides the contribution workflow for Apache Beam, including creating PRs, issue management, code review process, and release cycles. Use when contributing code, creating PRs, or understanding the contribution process. Use when this capability is needed.

tomevault-io Updated Sep 17, 2026

File contents

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

Search existing issues at https://github.com/apache/beam/issues
Create new issue using appropriate template

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

Discuss on dev@beam.apache.org mailing list
Create design doc using template
Review existing design docs

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
Use descriptive commit messages

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

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

User mailing list: user@beam.apache.org
Dev mailing list: dev@beam.apache.org
Slack: #beam channel
Issues: https://github.com/apache/beam/issues

Converted and distributed by TomeVault — claim your Tome and manage your conversions.

---name: contributingdescription: Guides the contribution workflow for Apache Beam, including creating PRs, issue management, code review process, and release cycles. Use when contributing code, creating PRs, or understanding the contribution process. Use when this capability is needed.---# 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)```bash./local-env-setup.sh```#### Docker-based Setup```bash./start-build-env.sh```## Contribution Workflow### 1. Find or Create an Issue- Search existing issues at https://github.com/apache/beam/issues- Create new issue using appropriate template### 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- Discuss on dev@beam.apache.org mailing list- Create design doc using [template](https://s.apache.org/beam-design-doc-template)- Review [existing design docs](https://s.apache.org/beam-design-docs)### 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- Use descriptive commit messages### 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](https://home.apache.org/phonebook.html?pmc=beam)## Testing Workflows### Pre-commit TestsRun automatically on PRs. To run locally:```bash./gradlew javaPreCommit # Java./gradlew :sdks:python:test # Python./gradlew :sdks:go:test # Go```### Post-commit TestsRun after merge. Trigger phrases in PR comments start specific test suites.See [trigger phrase catalog](https://github.com/apache/beam/blob/master/.test-infra/jenkins/README.md).## Formatting### Java```bash./gradlew spotlessApply```### Python```bash# Uses yapf, isort, pylintpre-commit run --all-files```### CHANGES.md```bash./gradlew formatChanges```## Release Cycle- Minor releases every 6 weeks- Check [release calendar](https://calendar.google.com/calendar/embed?src=0p73sl034k80oob7seouanigd0%40group.calendar.google.com)- 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- [Contribution Guide](https://beam.apache.org/contribute/)- [PTransform Style Guide](https://beam.apache.org/contribute/ptransform-style-guide)- [Runner Authoring Guide](https://beam.apache.org/contribute/runner-guide/)- [Wiki Tips](https://cwiki.apache.org/confluence/display/BEAM/) - [Git Tips](https://cwiki.apache.org/confluence/display/BEAM/Git+Tips) - [Java Tips](https://cwiki.apache.org/confluence/display/BEAM/Java+Tips) - [Python Tips](https://cwiki.apache.org/confluence/display/BEAM/Python+Tips) - [Go Tips](https://cwiki.apache.org/confluence/display/BEAM/Go+Tips) - [Gradle Tips](https://cwiki.apache.org/confluence/display/BEAM/Gradle+Tips)## Communication- User mailing list: user@beam.apache.org- Dev mailing list: dev@beam.apache.org- Slack: [#beam channel](https://s.apache.org/beam-slack-channel)- Issues: https://github.com/apache/beam/issues---> Converted and distributed by [TomeVault](https://tomevault.io/claim/apache) — claim your Tome and manage your conversions.

Frequently asked questions