diff --git a/contributor-docs/README.md b/contributor-docs/README.md new file mode 100644 index 000000000000..1087a74f05c7 --- /dev/null +++ b/contributor-docs/README.md @@ -0,0 +1,36 @@ + + +# 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 dev@beam.apache.org 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. \ No newline at end of file