dariabezkorovaina commented on a change in pull request #17089: URL: https://github.com/apache/beam/pull/17089#discussion_r833250843
########## File path: website/www/site/content/en/contribute/_index.md ########## @@ -57,46 +57,98 @@ There are lots of opportunities to contribute. You can for example: https://cwiki.apache.org/confluence/display/BEAM/Contributor+FAQ) - organize local meetups of users or contributors to Apache Beam +Below is a tutorial for contributing code to Beam, covering our tools and typical process in +detail. + </div> -<a class="arrow-list-header" data-toggle="collapse" href="#collapseContributing" role="button" aria-expanded="false" aria-controls="collapseContributing"> - {{< figure src="/images/arrow-icon_list.svg">}} +## Get Started -## Contributing code +### Connect with the Beam community - </a> +1. Consider [subscribing to the [email protected]](/community/contact-us/) mailing list, especially if you plan to make more than one change or the change will be large. All decisions are consensus-based and happen on the public mailing list. +1. (Optionally) Join the [#beam channel of the ASF slack](https://beam.apache.org/community/contact-us/). +1. Create an account on [Beam issue tracker (JIRA)](https://issues.apache.org/jira/projects/BEAM/issues) + (anyone can do this). -<div class="collapse dont-collapse-sm" id="collapseContributing"> +### Accounts and Permissions -Below is a tutorial for contributing code to Beam, covering our tools and typical process in -detail. +- [Beam issue tracker (JIRA)](https://issues.apache.org/jira/projects/BEAM/issues): + Anyone can access it and browse issues. Anyone can register an account and login + to create issues or add comments. Only contributors can be assigned issues. If + you want to be assigned issues, a PMC member can add you to the project contributor + group. Email the [[email protected]](/community/contact-us) + to ask to be added as a contributor in the Beam issue tracker, and include your ASF Jira username. + +- [Beam Wiki Space](https://cwiki.apache.org/confluence/display/BEAM/Apache+Beam): + Anyone has read access. If you wish to contribute changes, please create an account and request edit access on the + [[email protected]](https://beam.apache.org/community/contact-us) mailing list (include your Wiki account user ID). + +- Pull requests can only be merged by a + [Beam committer](https://home.apache.org/phonebook.html?pmc=beam). + +- [Voting on a release](https://www.apache.org/foundation/voting.html): Everyone can vote. Only + [Beam PMC](https://home.apache.org/phonebook.html?pmc=beam) members should mark their votes as binding. + +### Communication + +All communication is expected to align with the [Code of Conduct](https://www.apache.org/foundation/policies/conduct). + +Discussion about contributing code to Beam happens on the [[email protected] mailing list](/community/contact-us/). Introduce yourself! Review comment: change link to https://beam.apache.org/community/contact-us/ ########## File path: website/www/site/content/en/contribute/_index.md ########## @@ -57,46 +57,98 @@ There are lots of opportunities to contribute. You can for example: https://cwiki.apache.org/confluence/display/BEAM/Contributor+FAQ) - organize local meetups of users or contributors to Apache Beam +Below is a tutorial for contributing code to Beam, covering our tools and typical process in +detail. + </div> -<a class="arrow-list-header" data-toggle="collapse" href="#collapseContributing" role="button" aria-expanded="false" aria-controls="collapseContributing"> - {{< figure src="/images/arrow-icon_list.svg">}} +## Get Started -## Contributing code +### Connect with the Beam community - </a> +1. Consider [subscribing to the [email protected]](/community/contact-us/) mailing list, especially if you plan to make more than one change or the change will be large. All decisions are consensus-based and happen on the public mailing list. +1. (Optionally) Join the [#beam channel of the ASF slack](https://beam.apache.org/community/contact-us/). +1. Create an account on [Beam issue tracker (JIRA)](https://issues.apache.org/jira/projects/BEAM/issues) + (anyone can do this). -<div class="collapse dont-collapse-sm" id="collapseContributing"> +### Accounts and Permissions -Below is a tutorial for contributing code to Beam, covering our tools and typical process in -detail. +- [Beam issue tracker (JIRA)](https://issues.apache.org/jira/projects/BEAM/issues): + Anyone can access it and browse issues. Anyone can register an account and login + to create issues or add comments. Only contributors can be assigned issues. If + you want to be assigned issues, a PMC member can add you to the project contributor + group. Email the [[email protected]](/community/contact-us) + to ask to be added as a contributor in the Beam issue tracker, and include your ASF Jira username. + +- [Beam Wiki Space](https://cwiki.apache.org/confluence/display/BEAM/Apache+Beam): + Anyone has read access. If you wish to contribute changes, please create an account and request edit access on the + [[email protected]](https://beam.apache.org/community/contact-us) mailing list (include your Wiki account user ID). + +- Pull requests can only be merged by a + [Beam committer](https://home.apache.org/phonebook.html?pmc=beam). + +- [Voting on a release](https://www.apache.org/foundation/voting.html): Everyone can vote. Only + [Beam PMC](https://home.apache.org/phonebook.html?pmc=beam) members should mark their votes as binding. + +### Communication + +All communication is expected to align with the [Code of Conduct](https://www.apache.org/foundation/policies/conduct). + +Discussion about contributing code to Beam happens on the [[email protected] mailing list](/community/contact-us/). Introduce yourself! + +Questions can be asked on the [#beam channel of the ASF slack](https://beam.apache.org/community/contact-us/). Introduce yourself! + +<a class="arrow-list-header" data-toggle="collapse" href="#collapseContributing" role="button" aria-expanded="false" aria-controls="collapseContributing"> + +{{< figure src="/images/arrow-icon_list.svg">}} + +## Before You Begin + +</a> ### Prerequisites - - A GitHub account. - - A Linux, macOS, or Microsoft Windows development environment - - Java JDK 8 installed - - [Docker](https://www.docker.com/) installed for some tasks including building worker containers and testing this website - changes locally. - - For SDK Development: - - [Go](https://golang.org) 1.12 or later installed for Go SDK development Review comment: add dot at the end ########## File path: website/www/site/content/en/contribute/_index.md ########## @@ -57,46 +57,98 @@ There are lots of opportunities to contribute. You can for example: https://cwiki.apache.org/confluence/display/BEAM/Contributor+FAQ) - organize local meetups of users or contributors to Apache Beam +Below is a tutorial for contributing code to Beam, covering our tools and typical process in +detail. + </div> -<a class="arrow-list-header" data-toggle="collapse" href="#collapseContributing" role="button" aria-expanded="false" aria-controls="collapseContributing"> - {{< figure src="/images/arrow-icon_list.svg">}} +## Get Started -## Contributing code +### Connect with the Beam community - </a> +1. Consider [subscribing to the [email protected]](/community/contact-us/) mailing list, especially if you plan to make more than one change or the change will be large. All decisions are consensus-based and happen on the public mailing list. +1. (Optionally) Join the [#beam channel of the ASF slack](https://beam.apache.org/community/contact-us/). +1. Create an account on [Beam issue tracker (JIRA)](https://issues.apache.org/jira/projects/BEAM/issues) + (anyone can do this). -<div class="collapse dont-collapse-sm" id="collapseContributing"> +### Accounts and Permissions -Below is a tutorial for contributing code to Beam, covering our tools and typical process in -detail. +- [Beam issue tracker (JIRA)](https://issues.apache.org/jira/projects/BEAM/issues): + Anyone can access it and browse issues. Anyone can register an account and login + to create issues or add comments. Only contributors can be assigned issues. If + you want to be assigned issues, a PMC member can add you to the project contributor + group. Email the [[email protected]](/community/contact-us) + to ask to be added as a contributor in the Beam issue tracker, and include your ASF Jira username. + +- [Beam Wiki Space](https://cwiki.apache.org/confluence/display/BEAM/Apache+Beam): + Anyone has read access. If you wish to contribute changes, please create an account and request edit access on the + [[email protected]](https://beam.apache.org/community/contact-us) mailing list (include your Wiki account user ID). + +- Pull requests can only be merged by a + [Beam committer](https://home.apache.org/phonebook.html?pmc=beam). + +- [Voting on a release](https://www.apache.org/foundation/voting.html): Everyone can vote. Only + [Beam PMC](https://home.apache.org/phonebook.html?pmc=beam) members should mark their votes as binding. + +### Communication + +All communication is expected to align with the [Code of Conduct](https://www.apache.org/foundation/policies/conduct). + +Discussion about contributing code to Beam happens on the [[email protected] mailing list](/community/contact-us/). Introduce yourself! + +Questions can be asked on the [#beam channel of the ASF slack](https://beam.apache.org/community/contact-us/). Introduce yourself! + +<a class="arrow-list-header" data-toggle="collapse" href="#collapseContributing" role="button" aria-expanded="false" aria-controls="collapseContributing"> + +{{< figure src="/images/arrow-icon_list.svg">}} + +## Before You Begin + +</a> ### Prerequisites - - A GitHub account. - - A Linux, macOS, or Microsoft Windows development environment - - Java JDK 8 installed - - [Docker](https://www.docker.com/) installed for some tasks including building worker containers and testing this website - changes locally. - - For SDK Development: - - [Go](https://golang.org) 1.12 or later installed for Go SDK development - - Python 3.x interpreters. You will need Python interpreters for all Python versions supported by Beam. - Interpreters should be installed and available in shell via `python3.x` commands. For more information, see: - Python installation tips in [Developer Wiki](https://cwiki.apache.org/confluence/display/BEAM/Python+Tips#PythonTips-InstallingPythoninterpreters). - - For large contributions, a signed [Individual Contributor License - Agreement](https://www.apache.org/licenses/icla.pdf) (ICLA) to the Apache - Software Foundation (ASF). - - -### Configuration options +- A [GitHub](https://github.com/) account. +- A Linux, macOS, or Microsoft Windows development environment +- Java JDK 8 installed +- [Docker](https://www.docker.com/) installed for some tasks including building worker containers and testing this website + changes locally. +- For SDK Development: + - [Go](https://golang.org) 1.12 or later installed for Go SDK development + - Python 3.x interpreters. You will need Python interpreters for all Python versions supported by Beam. + Interpreters should be installed and available in shell via `python3.x` commands. For more information, see: + Python installation tips in [Developer Wiki](https://cwiki.apache.org/confluence/display/BEAM/Python+Tips#PythonTips-InstallingPythoninterpreters). +- For large contributions, a signed [Individual Contributor License + Agreement](https://www.apache.org/licenses/icla.pdf) (ICLA) to the Apache + Software Foundation (ASF). + +### Share Your Intent +1. Find or create an issue in the [Beam issue tracker (JIRA)](https://issues.apache.org/jira/projects/BEAM/issues). + Tracking your work in an issue will avoid duplicated or conflicting work, and provide + a place for notes. Later, your pull request will be linked to the issue as well. +1. Assign the issue to yourself. To get the permission to do so, email + the [[email protected] mailing list](https://beam.apache.org/community/contact-us) + to introduce yourself and to be added as a contributor in the Beam issue tracker including your + ASF Jira Username. For example [this welcome email](https://lists.apache.org/thread.html/e6018c2aaf7dc7895091434295e5b0fafe192b975e3e3761fcf0cda7@%3Cdev.beam.apache.org%3E). +1. If your change is large or it is your first change, it is a good idea to + [discuss it on the [email protected] mailing list](https://beam.apache.org/community/contact-us/). +1. For large changes create a design doc + ([template](https://s.apache.org/beam-design-doc-template), + [examples](https://s.apache.org/beam-design-docs)) and email it to the [[email protected] mailing list](https://beam.apache.org/community/contact-us/). + +### Setup Your Environment + Review comment: Add: Before you begin, check out the Wiki pages. There are many useful tips about [Git](https://cwiki.apache.org/confluence/display/BEAM/Git+Tips), [Go](https://cwiki.apache.org/confluence/display/BEAM/Go+Tips), [Gradle](https://cwiki.apache.org/confluence/display/BEAM/Gradle+Tips), [Java](https://cwiki.apache.org/confluence/display/BEAM/Java+Tips), [Python](https://cwiki.apache.org/confluence/display/BEAM/Python+Tips), etc. ########## File path: website/www/site/content/en/contribute/_index.md ########## @@ -57,46 +57,98 @@ There are lots of opportunities to contribute. You can for example: https://cwiki.apache.org/confluence/display/BEAM/Contributor+FAQ) - organize local meetups of users or contributors to Apache Beam +Below is a tutorial for contributing code to Beam, covering our tools and typical process in +detail. + </div> -<a class="arrow-list-header" data-toggle="collapse" href="#collapseContributing" role="button" aria-expanded="false" aria-controls="collapseContributing"> - {{< figure src="/images/arrow-icon_list.svg">}} +## Get Started -## Contributing code +### Connect with the Beam community - </a> +1. Consider [subscribing to the [email protected]](/community/contact-us/) mailing list, especially if you plan to make more than one change or the change will be large. All decisions are consensus-based and happen on the public mailing list. +1. (Optionally) Join the [#beam channel of the ASF slack](https://beam.apache.org/community/contact-us/). +1. Create an account on [Beam issue tracker (JIRA)](https://issues.apache.org/jira/projects/BEAM/issues) + (anyone can do this). -<div class="collapse dont-collapse-sm" id="collapseContributing"> +### Accounts and Permissions -Below is a tutorial for contributing code to Beam, covering our tools and typical process in -detail. +- [Beam issue tracker (JIRA)](https://issues.apache.org/jira/projects/BEAM/issues): + Anyone can access it and browse issues. Anyone can register an account and login + to create issues or add comments. Only contributors can be assigned issues. If + you want to be assigned issues, a PMC member can add you to the project contributor + group. Email the [[email protected]](/community/contact-us) + to ask to be added as a contributor in the Beam issue tracker, and include your ASF Jira username. + +- [Beam Wiki Space](https://cwiki.apache.org/confluence/display/BEAM/Apache+Beam): + Anyone has read access. If you wish to contribute changes, please create an account and request edit access on the + [[email protected]](https://beam.apache.org/community/contact-us) mailing list (include your Wiki account user ID). + +- Pull requests can only be merged by a + [Beam committer](https://home.apache.org/phonebook.html?pmc=beam). + +- [Voting on a release](https://www.apache.org/foundation/voting.html): Everyone can vote. Only + [Beam PMC](https://home.apache.org/phonebook.html?pmc=beam) members should mark their votes as binding. + +### Communication + +All communication is expected to align with the [Code of Conduct](https://www.apache.org/foundation/policies/conduct). + +Discussion about contributing code to Beam happens on the [[email protected] mailing list](/community/contact-us/). Introduce yourself! + +Questions can be asked on the [#beam channel of the ASF slack](https://beam.apache.org/community/contact-us/). Introduce yourself! + +<a class="arrow-list-header" data-toggle="collapse" href="#collapseContributing" role="button" aria-expanded="false" aria-controls="collapseContributing"> + +{{< figure src="/images/arrow-icon_list.svg">}} + +## Before You Begin + +</a> ### Prerequisites - - A GitHub account. - - A Linux, macOS, or Microsoft Windows development environment Review comment: add dot at the end ########## File path: website/www/site/content/en/contribute/_index.md ########## @@ -140,122 +192,109 @@ You can install these in a Debian-based distribution for Linux or macOs using th * Python * Docker -To install: - -1. Execute: +To install execute: ``` ./local-env-setup.sh ``` -#### Container: Docker-based +##### Container: Docker-based Alternatively, you can use the Docker based local development environment to wrap your clone of the Beam repo into a container meeting the requirements above. -You can start this container using the [start-build-env.sh](https://github.com/apache/beam/blob/master/start-build-env.sh) -script which is part of the Beam repo: +You can start this container using the [start-build-env.sh](https://github.com/apache/beam/blob/master/start-build-env.sh) script which is part of the Beam repo. -1. Execute: +Execute: ``` ./start-build-env.sh ``` -### Connect With the Beam community +#### Development Setup {#development-setup} -1. Consider subscribing to the [dev@ mailing list](/community/contact-us/), especially - if you plan to make more than one change or the change will be large. All decisions happen on the - public dev list. -1. (Optionally) Join the [#beam channel of the ASF slack](/community/contact-us/). -1. Create an account on [Beam issue tracker (JIRA)](https://issues.apache.org/jira/projects/BEAM/issues) - (anyone can do this). +1. Check [Git workflow tips](https://cwiki.apache.org/confluence/display/BEAM/Git+Tips) if you need help with git forking, cloning, branching, committing, pull requests, and squashing commits. -### Share your intent +2. Clone the git repository. You can download it anywhere you like. +``` +$ mkdir -p ~/go/src/github.com/apache +$ cd ~/go/src/github.com/apache +$ git clone https://github.com/apache/beam +$ cd beam +``` -1. Find or create an issue in the [Beam issue tracker (JIRA)](https://issues.apache.org/jira/projects/BEAM/issues). - Tracking your work in an issue will avoid duplicated or conflicting work, and provide - a place for notes. Later, your pull request will be linked to the issue as well. -1. If you want to get involved but don't have a project in mind, check our list of open starter tasks, - [https://s.apache.org/beam-starter-tasks](https://s.apache.org/beam-starter-tasks). -1. Assign the issue to yourself. To get the permission to do so, email - the [dev@ mailing list](/community/contact-us) - to introduce yourself and to be added as a contributor in the Beam issue tracker including your - ASF Jira Username. For example [this welcome email](https://lists.apache.org/thread.html/e6018c2aaf7dc7895091434295e5b0fafe192b975e3e3761fcf0cda7@%3Cdev.beam.apache.org%3E). -1. If your change is large or it is your first change, it is a good idea to - [discuss it on the dev@ mailing list](/community/contact-us/). -1. For large changes create a design doc - ([template](https://s.apache.org/beam-design-doc-template), - [examples](https://s.apache.org/beam-design-docs)) and email it to the [dev@ mailing list](/community/contact-us). -### Development Setup {#development-setup} +  For **Go development**: -1. Check [Git workflow tips](https://cwiki.apache.org/confluence/display/BEAM/Git+Tips) if you need help with git forking, cloning, branching, committing, pull requests, and squashing commits. -1. Clone the git repository. You can download it anywhere you like. - - $ mkdir -p ~/go/src/github.com/apache - $ cd ~/go/src/github.com/apache - $ git clone https://github.com/apache/beam - $ cd beam - - - For Go development: - We recommend putting it in your [`$GOPATH`](https://golang.org/doc/gopath_code#GOPATH) (`$HOME/go` by default on Unix systems). - 1. Clone the repo, and update your branch as normal - $ git clone https://github.com/apache/beam.git - $ cd beam - $ git remote add <GitHub_user> [email protected]:<GitHub_user>/beam.git - $ git fetch --all - 1. Get or Update all the Go SDK dependencies Review comment: add **:** at the end of the line ########## File path: website/www/site/content/en/contribute/_index.md ########## @@ -321,69 +367,42 @@ export GOLANG_PROTOBUF_REGISTRATION_CONFLICT=ignore all commits in the PR during merge, however if a PR has a mixture of independent changes that should not be squashed, and fixup commits, then the PR author should help squashing fixup commits to maintain a clean commit history. -</div> - -## When will my change show up in an Apache Beam release? +#### Apache Beam Releases Apache Beam makes minor releases every 6 weeks. Apache Beam has a [calendar](https://calendar.google.com/calendar/embed?src=0p73sl034k80oob7seouanigd0%40group.calendar.google.com) for cutting the next release branch. Your change needs to be checked into master before the release branch is cut to make the next release. -## Stale pull requests +#### Stale Pull Requests The community will close stale pull requests in order to keep the project healthy. A pull request becomes stale after its author fails to respond to actionable comments for 60 days. Author of a closed pull request is welcome to reopen the same pull request again in the future. The associated JIRAs will be unassigned from the author but will stay open. -## Accounts and Permissions - -- [Beam issue tracker (JIRA)](https://issues.apache.org/jira/projects/BEAM/issues): - Anyone can access it and browse issues. Anyone can register an account and login - to create issues or add comments. Only contributors can be assigned issues. If - you want to be assigned issues, a PMC member can add you to the project contributor - group. Email the [dev@ mailing list](/community/contact-us) - to ask to be added as a contributor in the Beam issue tracker, and include your ASF Jira username. - -- [Beam Wiki Space](https://cwiki.apache.org/confluence/display/BEAM/Apache+Beam): - Anyone has read access. If you wish to contribute changes, please create an account and request edit access on the - [dev@ mailing list](/community/contact-us) (include your Wiki account user ID). - -- Pull requests can only be merged by a - [Beam committer](https://home.apache.org/phonebook.html?pmc=beam). - -- [Voting on a release](https://www.apache.org/foundation/voting.html): Everyone can vote. Only - [Beam PMC](https://home.apache.org/phonebook.html?pmc=beam) members should mark their votes as binding. +### Troubleshooting -## Communication +If you run into any issues, check out the [contribution FAQ](https://cwiki.apache.org/confluence/display/BEAM/Contributor+FAQ) or ask on the [dev@ mailing list](/community/contact-us/) or [#beam channel of the ASF slack](/community/contact-us/). Review comment: pls change link to : https://beam.apache.org/community/contact-us/ slack -> Slack ########## File path: website/www/site/content/en/contribute/_index.md ########## @@ -321,69 +367,42 @@ export GOLANG_PROTOBUF_REGISTRATION_CONFLICT=ignore all commits in the PR during merge, however if a PR has a mixture of independent changes that should not be squashed, and fixup commits, then the PR author should help squashing fixup commits to maintain a clean commit history. -</div> - -## When will my change show up in an Apache Beam release? +#### Apache Beam Releases Apache Beam makes minor releases every 6 weeks. Apache Beam has a [calendar](https://calendar.google.com/calendar/embed?src=0p73sl034k80oob7seouanigd0%40group.calendar.google.com) for cutting the next release branch. Your change needs to be checked into master before the release branch is cut to make the next release. -## Stale pull requests +#### Stale Pull Requests The community will close stale pull requests in order to keep the project healthy. A pull request becomes stale after its author fails to respond to actionable comments for 60 days. Author of a closed pull request is welcome to reopen the same pull request again in the future. The associated JIRAs will be unassigned from the author but will stay open. -## Accounts and Permissions - -- [Beam issue tracker (JIRA)](https://issues.apache.org/jira/projects/BEAM/issues): - Anyone can access it and browse issues. Anyone can register an account and login - to create issues or add comments. Only contributors can be assigned issues. If - you want to be assigned issues, a PMC member can add you to the project contributor - group. Email the [dev@ mailing list](/community/contact-us) - to ask to be added as a contributor in the Beam issue tracker, and include your ASF Jira username. - -- [Beam Wiki Space](https://cwiki.apache.org/confluence/display/BEAM/Apache+Beam): - Anyone has read access. If you wish to contribute changes, please create an account and request edit access on the - [dev@ mailing list](/community/contact-us) (include your Wiki account user ID). - -- Pull requests can only be merged by a - [Beam committer](https://home.apache.org/phonebook.html?pmc=beam). - -- [Voting on a release](https://www.apache.org/foundation/voting.html): Everyone can vote. Only - [Beam PMC](https://home.apache.org/phonebook.html?pmc=beam) members should mark their votes as binding. +### Troubleshooting -## Communication +If you run into any issues, check out the [contribution FAQ](https://cwiki.apache.org/confluence/display/BEAM/Contributor+FAQ) or ask on the [dev@ mailing list](/community/contact-us/) or [#beam channel of the ASF slack](/community/contact-us/). -All communication is expected to align with the [Code of Conduct](https://www.apache.org/foundation/policies/conduct). +If you didn't find the information you were looking for in this guide, please +[reach out to the Beam community](/community/contact-us). -Discussion about contributing code to Beam happens on the [dev@ mailing list](/community/contact-us/). Introduce yourself! +</div> -Questions can be asked on the [#beam channel of the ASF slack](/community/contact-us/). Introduce yourself! +## Find Efforts to Contribute to +A great way to contribute is to join an existing effort. If you want to get involved but don’t have a project in mind, check our [list of open starter tasks](https://s.apache.org/beam-starter-tasks). +For the most intensive efforts, check out the [roadmap](https://beam.apache.org/roadmap/). -## Additional resources +## Additional Resources +Please see Beam developers’ Wiki Contributor FAQ for more information. Review comment: Link to: https://cwiki.apache.org/confluence/display/BEAM/Contributor+FAQ ########## File path: website/www/site/content/en/contribute/_index.md ########## @@ -321,69 +367,42 @@ export GOLANG_PROTOBUF_REGISTRATION_CONFLICT=ignore all commits in the PR during merge, however if a PR has a mixture of independent changes that should not be squashed, and fixup commits, then the PR author should help squashing fixup commits to maintain a clean commit history. -</div> - -## When will my change show up in an Apache Beam release? +#### Apache Beam Releases Apache Beam makes minor releases every 6 weeks. Apache Beam has a [calendar](https://calendar.google.com/calendar/embed?src=0p73sl034k80oob7seouanigd0%40group.calendar.google.com) for cutting the next release branch. Your change needs to be checked into master before the release branch is cut to make the next release. -## Stale pull requests +#### Stale Pull Requests The community will close stale pull requests in order to keep the project healthy. A pull request becomes stale after its author fails to respond to actionable comments for 60 days. Author of a closed pull request is welcome to reopen the same pull request again in the future. The associated JIRAs will be unassigned from the author but will stay open. -## Accounts and Permissions - -- [Beam issue tracker (JIRA)](https://issues.apache.org/jira/projects/BEAM/issues): - Anyone can access it and browse issues. Anyone can register an account and login - to create issues or add comments. Only contributors can be assigned issues. If - you want to be assigned issues, a PMC member can add you to the project contributor - group. Email the [dev@ mailing list](/community/contact-us) - to ask to be added as a contributor in the Beam issue tracker, and include your ASF Jira username. - -- [Beam Wiki Space](https://cwiki.apache.org/confluence/display/BEAM/Apache+Beam): - Anyone has read access. If you wish to contribute changes, please create an account and request edit access on the - [dev@ mailing list](/community/contact-us) (include your Wiki account user ID). - -- Pull requests can only be merged by a - [Beam committer](https://home.apache.org/phonebook.html?pmc=beam). - -- [Voting on a release](https://www.apache.org/foundation/voting.html): Everyone can vote. Only - [Beam PMC](https://home.apache.org/phonebook.html?pmc=beam) members should mark their votes as binding. +### Troubleshooting -## Communication +If you run into any issues, check out the [contribution FAQ](https://cwiki.apache.org/confluence/display/BEAM/Contributor+FAQ) or ask on the [dev@ mailing list](/community/contact-us/) or [#beam channel of the ASF slack](/community/contact-us/). -All communication is expected to align with the [Code of Conduct](https://www.apache.org/foundation/policies/conduct). +If you didn't find the information you were looking for in this guide, please +[reach out to the Beam community](/community/contact-us). -Discussion about contributing code to Beam happens on the [dev@ mailing list](/community/contact-us/). Introduce yourself! +</div> -Questions can be asked on the [#beam channel of the ASF slack](/community/contact-us/). Introduce yourself! +## Find Efforts to Contribute to +A great way to contribute is to join an existing effort. If you want to get involved but don’t have a project in mind, check our [list of open starter tasks](https://s.apache.org/beam-starter-tasks). +For the most intensive efforts, check out the [roadmap](https://beam.apache.org/roadmap/). -## Additional resources +## Additional Resources +Please see Beam developers’ Wiki Contributor FAQ for more information. -If you are contributing a `PTransform` to Beam, we have an extensive -[PTransform Style Guide](/contribute/ptransform-style-guide). +If you are contributing a [PTransform](https://s.apache.org/beam-starter-tasks) to Beam, we have an extensive [PTransform Style Guide](https://beam.apache.org/contribute/ptransform-style-guide). Review comment: Unlink "PTransform" - should be code-style  ########## File path: website/www/site/content/en/contribute/_index.md ########## @@ -300,10 +347,9 @@ export GOLANG_PROTOBUF_REGISTRATION_CONFLICT=ignore Use `R: @username` in the pull request to notify a reviewer. -1. If you don't get any response in 3 business days, email the [dev@ mailing list](/community/contact-us) to ask for someone to look at your pull - request. +1. If you don't get any response in 3 business days, email the [[email protected] mailing list](/community/contact-us) to ask for someone to look at your pull request. Review comment: Pls change link to : https://beam.apache.org/community/contact-us/ ########## File path: website/www/site/content/en/contribute/_index.md ########## @@ -57,46 +57,98 @@ There are lots of opportunities to contribute. You can for example: https://cwiki.apache.org/confluence/display/BEAM/Contributor+FAQ) - organize local meetups of users or contributors to Apache Beam +Below is a tutorial for contributing code to Beam, covering our tools and typical process in +detail. + </div> -<a class="arrow-list-header" data-toggle="collapse" href="#collapseContributing" role="button" aria-expanded="false" aria-controls="collapseContributing"> - {{< figure src="/images/arrow-icon_list.svg">}} +## Get Started -## Contributing code +### Connect with the Beam community - </a> +1. Consider [subscribing to the [email protected]](/community/contact-us/) mailing list, especially if you plan to make more than one change or the change will be large. All decisions are consensus-based and happen on the public mailing list. +1. (Optionally) Join the [#beam channel of the ASF slack](https://beam.apache.org/community/contact-us/). +1. Create an account on [Beam issue tracker (JIRA)](https://issues.apache.org/jira/projects/BEAM/issues) + (anyone can do this). -<div class="collapse dont-collapse-sm" id="collapseContributing"> +### Accounts and Permissions -Below is a tutorial for contributing code to Beam, covering our tools and typical process in -detail. +- [Beam issue tracker (JIRA)](https://issues.apache.org/jira/projects/BEAM/issues): + Anyone can access it and browse issues. Anyone can register an account and login + to create issues or add comments. Only contributors can be assigned issues. If + you want to be assigned issues, a PMC member can add you to the project contributor + group. Email the [[email protected]](/community/contact-us) + to ask to be added as a contributor in the Beam issue tracker, and include your ASF Jira username. + +- [Beam Wiki Space](https://cwiki.apache.org/confluence/display/BEAM/Apache+Beam): + Anyone has read access. If you wish to contribute changes, please create an account and request edit access on the + [[email protected]](https://beam.apache.org/community/contact-us) mailing list (include your Wiki account user ID). + +- Pull requests can only be merged by a + [Beam committer](https://home.apache.org/phonebook.html?pmc=beam). + +- [Voting on a release](https://www.apache.org/foundation/voting.html): Everyone can vote. Only + [Beam PMC](https://home.apache.org/phonebook.html?pmc=beam) members should mark their votes as binding. + +### Communication + +All communication is expected to align with the [Code of Conduct](https://www.apache.org/foundation/policies/conduct). + +Discussion about contributing code to Beam happens on the [[email protected] mailing list](/community/contact-us/). Introduce yourself! + +Questions can be asked on the [#beam channel of the ASF slack](https://beam.apache.org/community/contact-us/). Introduce yourself! + +<a class="arrow-list-header" data-toggle="collapse" href="#collapseContributing" role="button" aria-expanded="false" aria-controls="collapseContributing"> + +{{< figure src="/images/arrow-icon_list.svg">}} + +## Before You Begin + +</a> ### Prerequisites - - A GitHub account. - - A Linux, macOS, or Microsoft Windows development environment - - Java JDK 8 installed Review comment: add dot at the end ########## File path: website/www/site/content/en/contribute/_index.md ########## @@ -140,122 +192,109 @@ You can install these in a Debian-based distribution for Linux or macOs using th * Python * Docker -To install: - -1. Execute: +To install execute: ``` ./local-env-setup.sh ``` -#### Container: Docker-based +##### Container: Docker-based Alternatively, you can use the Docker based local development environment to wrap your clone of the Beam repo into a container meeting the requirements above. -You can start this container using the [start-build-env.sh](https://github.com/apache/beam/blob/master/start-build-env.sh) -script which is part of the Beam repo: +You can start this container using the [start-build-env.sh](https://github.com/apache/beam/blob/master/start-build-env.sh) script which is part of the Beam repo. -1. Execute: +Execute: ``` ./start-build-env.sh ``` -### Connect With the Beam community +#### Development Setup {#development-setup} -1. Consider subscribing to the [dev@ mailing list](/community/contact-us/), especially - if you plan to make more than one change or the change will be large. All decisions happen on the - public dev list. -1. (Optionally) Join the [#beam channel of the ASF slack](/community/contact-us/). -1. Create an account on [Beam issue tracker (JIRA)](https://issues.apache.org/jira/projects/BEAM/issues) - (anyone can do this). +1. Check [Git workflow tips](https://cwiki.apache.org/confluence/display/BEAM/Git+Tips) if you need help with git forking, cloning, branching, committing, pull requests, and squashing commits. -### Share your intent +2. Clone the git repository. You can download it anywhere you like. +``` +$ mkdir -p ~/go/src/github.com/apache +$ cd ~/go/src/github.com/apache +$ git clone https://github.com/apache/beam +$ cd beam +``` -1. Find or create an issue in the [Beam issue tracker (JIRA)](https://issues.apache.org/jira/projects/BEAM/issues). - Tracking your work in an issue will avoid duplicated or conflicting work, and provide - a place for notes. Later, your pull request will be linked to the issue as well. -1. If you want to get involved but don't have a project in mind, check our list of open starter tasks, - [https://s.apache.org/beam-starter-tasks](https://s.apache.org/beam-starter-tasks). -1. Assign the issue to yourself. To get the permission to do so, email - the [dev@ mailing list](/community/contact-us) - to introduce yourself and to be added as a contributor in the Beam issue tracker including your - ASF Jira Username. For example [this welcome email](https://lists.apache.org/thread.html/e6018c2aaf7dc7895091434295e5b0fafe192b975e3e3761fcf0cda7@%3Cdev.beam.apache.org%3E). -1. If your change is large or it is your first change, it is a good idea to - [discuss it on the dev@ mailing list](/community/contact-us/). -1. For large changes create a design doc - ([template](https://s.apache.org/beam-design-doc-template), - [examples](https://s.apache.org/beam-design-docs)) and email it to the [dev@ mailing list](/community/contact-us). -### Development Setup {#development-setup} +  For **Go development**: -1. Check [Git workflow tips](https://cwiki.apache.org/confluence/display/BEAM/Git+Tips) if you need help with git forking, cloning, branching, committing, pull requests, and squashing commits. -1. Clone the git repository. You can download it anywhere you like. - - $ mkdir -p ~/go/src/github.com/apache - $ cd ~/go/src/github.com/apache - $ git clone https://github.com/apache/beam - $ cd beam - - - For Go development: - We recommend putting it in your [`$GOPATH`](https://golang.org/doc/gopath_code#GOPATH) (`$HOME/go` by default on Unix systems). - 1. Clone the repo, and update your branch as normal Review comment: add **:** at the end of the line ########## File path: website/www/site/content/en/contribute/_index.md ########## @@ -57,46 +57,98 @@ There are lots of opportunities to contribute. You can for example: https://cwiki.apache.org/confluence/display/BEAM/Contributor+FAQ) - organize local meetups of users or contributors to Apache Beam +Below is a tutorial for contributing code to Beam, covering our tools and typical process in +detail. + </div> -<a class="arrow-list-header" data-toggle="collapse" href="#collapseContributing" role="button" aria-expanded="false" aria-controls="collapseContributing"> - {{< figure src="/images/arrow-icon_list.svg">}} +## Get Started -## Contributing code +### Connect with the Beam community - </a> +1. Consider [subscribing to the [email protected]](/community/contact-us/) mailing list, especially if you plan to make more than one change or the change will be large. All decisions are consensus-based and happen on the public mailing list. +1. (Optionally) Join the [#beam channel of the ASF slack](https://beam.apache.org/community/contact-us/). +1. Create an account on [Beam issue tracker (JIRA)](https://issues.apache.org/jira/projects/BEAM/issues) + (anyone can do this). -<div class="collapse dont-collapse-sm" id="collapseContributing"> +### Accounts and Permissions -Below is a tutorial for contributing code to Beam, covering our tools and typical process in -detail. +- [Beam issue tracker (JIRA)](https://issues.apache.org/jira/projects/BEAM/issues): + Anyone can access it and browse issues. Anyone can register an account and login + to create issues or add comments. Only contributors can be assigned issues. If + you want to be assigned issues, a PMC member can add you to the project contributor + group. Email the [[email protected]](/community/contact-us) + to ask to be added as a contributor in the Beam issue tracker, and include your ASF Jira username. + +- [Beam Wiki Space](https://cwiki.apache.org/confluence/display/BEAM/Apache+Beam): + Anyone has read access. If you wish to contribute changes, please create an account and request edit access on the + [[email protected]](https://beam.apache.org/community/contact-us) mailing list (include your Wiki account user ID). + +- Pull requests can only be merged by a + [Beam committer](https://home.apache.org/phonebook.html?pmc=beam). + +- [Voting on a release](https://www.apache.org/foundation/voting.html): Everyone can vote. Only + [Beam PMC](https://home.apache.org/phonebook.html?pmc=beam) members should mark their votes as binding. + +### Communication + +All communication is expected to align with the [Code of Conduct](https://www.apache.org/foundation/policies/conduct). + +Discussion about contributing code to Beam happens on the [[email protected] mailing list](/community/contact-us/). Introduce yourself! + +Questions can be asked on the [#beam channel of the ASF slack](https://beam.apache.org/community/contact-us/). Introduce yourself! + +<a class="arrow-list-header" data-toggle="collapse" href="#collapseContributing" role="button" aria-expanded="false" aria-controls="collapseContributing"> + +{{< figure src="/images/arrow-icon_list.svg">}} + +## Before You Begin + +</a> ### Prerequisites - - A GitHub account. - - A Linux, macOS, or Microsoft Windows development environment - - Java JDK 8 installed - - [Docker](https://www.docker.com/) installed for some tasks including building worker containers and testing this website - changes locally. - - For SDK Development: - - [Go](https://golang.org) 1.12 or later installed for Go SDK development - - Python 3.x interpreters. You will need Python interpreters for all Python versions supported by Beam. - Interpreters should be installed and available in shell via `python3.x` commands. For more information, see: - Python installation tips in [Developer Wiki](https://cwiki.apache.org/confluence/display/BEAM/Python+Tips#PythonTips-InstallingPythoninterpreters). - - For large contributions, a signed [Individual Contributor License - Agreement](https://www.apache.org/licenses/icla.pdf) (ICLA) to the Apache - Software Foundation (ASF). - - -### Configuration options +- A [GitHub](https://github.com/) account. +- A Linux, macOS, or Microsoft Windows development environment +- Java JDK 8 installed +- [Docker](https://www.docker.com/) installed for some tasks including building worker containers and testing this website + changes locally. +- For SDK Development: + - [Go](https://golang.org) 1.12 or later installed for Go SDK development + - Python 3.x interpreters. You will need Python interpreters for all Python versions supported by Beam. + Interpreters should be installed and available in shell via `python3.x` commands. For more information, see: + Python installation tips in [Developer Wiki](https://cwiki.apache.org/confluence/display/BEAM/Python+Tips#PythonTips-InstallingPythoninterpreters). +- For large contributions, a signed [Individual Contributor License + Agreement](https://www.apache.org/licenses/icla.pdf) (ICLA) to the Apache + Software Foundation (ASF). + +### Share Your Intent +1. Find or create an issue in the [Beam issue tracker (JIRA)](https://issues.apache.org/jira/projects/BEAM/issues). + Tracking your work in an issue will avoid duplicated or conflicting work, and provide + a place for notes. Later, your pull request will be linked to the issue as well. Review comment: Add: You may find the [Jira beginner’s guide](https://cwiki.apache.org/confluence/display/BEAM/Beam+Jira+Beginner%27s+Guide) and some useful [Jira tips](https://cwiki.apache.org/confluence/display/BEAM/Jira+Tips) in our Wiki. ########## File path: website/www/site/content/en/contribute/_index.md ########## @@ -321,69 +367,42 @@ export GOLANG_PROTOBUF_REGISTRATION_CONFLICT=ignore all commits in the PR during merge, however if a PR has a mixture of independent changes that should not be squashed, and fixup commits, then the PR author should help squashing fixup commits to maintain a clean commit history. -</div> - -## When will my change show up in an Apache Beam release? +#### Apache Beam Releases Apache Beam makes minor releases every 6 weeks. Apache Beam has a [calendar](https://calendar.google.com/calendar/embed?src=0p73sl034k80oob7seouanigd0%40group.calendar.google.com) for cutting the next release branch. Your change needs to be checked into master before the release branch is cut to make the next release. -## Stale pull requests +#### Stale Pull Requests The community will close stale pull requests in order to keep the project healthy. A pull request becomes stale after its author fails to respond to actionable comments for 60 days. Author of a closed pull request is welcome to reopen the same pull request again in the future. The associated JIRAs will be unassigned from the author but will stay open. -## Accounts and Permissions - -- [Beam issue tracker (JIRA)](https://issues.apache.org/jira/projects/BEAM/issues): - Anyone can access it and browse issues. Anyone can register an account and login - to create issues or add comments. Only contributors can be assigned issues. If - you want to be assigned issues, a PMC member can add you to the project contributor - group. Email the [dev@ mailing list](/community/contact-us) - to ask to be added as a contributor in the Beam issue tracker, and include your ASF Jira username. - -- [Beam Wiki Space](https://cwiki.apache.org/confluence/display/BEAM/Apache+Beam): - Anyone has read access. If you wish to contribute changes, please create an account and request edit access on the - [dev@ mailing list](/community/contact-us) (include your Wiki account user ID). - -- Pull requests can only be merged by a - [Beam committer](https://home.apache.org/phonebook.html?pmc=beam). - -- [Voting on a release](https://www.apache.org/foundation/voting.html): Everyone can vote. Only - [Beam PMC](https://home.apache.org/phonebook.html?pmc=beam) members should mark their votes as binding. +### Troubleshooting -## Communication +If you run into any issues, check out the [contribution FAQ](https://cwiki.apache.org/confluence/display/BEAM/Contributor+FAQ) or ask on the [dev@ mailing list](/community/contact-us/) or [#beam channel of the ASF slack](/community/contact-us/). -All communication is expected to align with the [Code of Conduct](https://www.apache.org/foundation/policies/conduct). +If you didn't find the information you were looking for in this guide, please +[reach out to the Beam community](/community/contact-us). Review comment: https://beam.apache.org/community/contact-us/ -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
