Skip to content

[Docs] Add table of contents for contributor docs #36861

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
+36 −0
Open

[Docs] Add table of contents for contributor docs #36861

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a83e8c7
Add table of contents for contributor docs
jrmccluskey Nov 18, 2025
97dee2b
add apache license
jrmccluskey Nov 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions contributor-docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
<!--
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->

# Contributor Documentation

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

## Table of Contents

- [Code Change Guide](code-change-guide.md): 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](committer-guide.md): Guidelines for Beam committers regarding code review, pull request objectives, merging processes, and post-merge tasks.
- [Committer Onboarding](committer-onboarding.md): A checklist for new Beam committers to set up their accounts and permissions.
- [Java Dependency Upgrades](java-dependency-upgrades.md): Instructions for upgrading Java dependencies in Beam, including running linkage checkers and verification tests.
- [Python Tips](python-tips.md): Tips and instructions for developing the Python SDK, including environment setup, running tests, and handling dependencies.
- [RC Testing Guide](rc-testing-guide.md): A guide for testing Beam Release Candidates (RCs) against downstream projects for Python, Java, and Go SDKs.
- [Release Guide](release-guide.md): A comprehensive guide for the Release Manager on how to perform a Beam release, from preparation to promotion.
- [Updating Supported Python Versions](updating-supported-python-versions.md): Instructions for adding support for new Python versions or removing support for end-of-life versions in Apache Beam.

## Discussion Documents

The [discussion-docs](discussion-docs/) directory contains discussion documents and proposals that have been mailed to the [email protected] mailing list, organized by year.

## Confluence Wiki

The [Confluence wiki](https://cwiki.apache.org/confluence/display/BEAM) for Apache Beam contains additional documentation and information for contributors. Some information may be out of date, but is still useful for reference.
Loading