|
| 1 | +<!-- |
| 2 | +Licensed under the Apache License, Version 2.0 (the "License"); |
| 3 | +you may not use this file except in compliance with the License. |
| 4 | +You may obtain a copy of the License at |
| 5 | +
|
| 6 | +http://www.apache.org/licenses/LICENSE-2.0 |
| 7 | +
|
| 8 | +Unless required by applicable law or agreed to in writing, software |
| 9 | +distributed under the License is distributed on an "AS IS" BASIS, |
| 10 | +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 11 | +See the License for the specific language governing permissions and |
| 12 | +limitations under the License. |
| 13 | +--> |
| 14 | + |
| 15 | +# Contributor Documentation |
| 16 | + |
| 17 | +This directory contains documentation for contributors to the Apache Beam project. |
| 18 | + |
| 19 | +## Table of Contents |
| 20 | + |
| 21 | +- [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. |
| 22 | +- [Committer Guide](committer-guide.md): Guidelines for Beam committers regarding code review, pull request objectives, merging processes, and post-merge tasks. |
| 23 | +- [Committer Onboarding](committer-onboarding.md): A checklist for new Beam committers to set up their accounts and permissions. |
| 24 | +- [Java Dependency Upgrades](java-dependency-upgrades.md): Instructions for upgrading Java dependencies in Beam, including running linkage checkers and verification tests. |
| 25 | +- [Python Tips](python-tips.md): Tips and instructions for developing the Python SDK, including environment setup, running tests, and handling dependencies. |
| 26 | +- [RC Testing Guide](rc-testing-guide.md): A guide for testing Beam Release Candidates (RCs) against downstream projects for Python, Java, and Go SDKs. |
| 27 | +- [Release Guide](release-guide.md): A comprehensive guide for the Release Manager on how to perform a Beam release, from preparation to promotion. |
| 28 | +- [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. |
| 29 | + |
| 30 | +## Discussion Documents |
| 31 | + |
| 32 | +The [discussion-docs ](discussion-docs/) directory contains discussion documents and proposals that have been mailed to the [email protected] mailing list, organized by year. |
| 33 | + |
| 34 | +## Confluence Wiki |
| 35 | + |
| 36 | +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. |
0 commit comments