bullet03 commented on a change in pull request #17089: URL: https://github.com/apache/beam/pull/17089#discussion_r833172581
########## File path: website/www/site/content/en/contribute/_index.md ########## @@ -57,46 +57,102 @@ 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 [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). -<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 [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. + +### 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 [dev@ mailing list](/community/contact-us/). Introduce yourself! + +Questions can be asked on the [#beam channel of the ASF slack](/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 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. 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). Review comment: done ########## File path: website/www/site/content/en/contribute/_index.md ########## @@ -57,46 +57,102 @@ 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 [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). -<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 [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. + +### 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 [dev@ mailing list](/community/contact-us/). Introduce yourself! Review comment: done -- 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]
