You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@beam.apache.org by GitBox <gi...@apache.org> on 2022/03/14 19:54:32 UTC
[GitHub] [beam] bullet03 opened a new pull request #17089: [BEAM-13992] [Website] update Contribute/Code Contribution Guide page
bullet03 opened a new pull request #17089:
URL: https://github.com/apache/beam/pull/17089
[BEAM-13992]
- update titles
- add text
- change links
- swapped text paragraphs
------------------------
Thank you for your contribution! Follow this checklist to help us incorporate your contribution quickly and easily:
- [ ] [**Choose reviewer(s)**](https://beam.apache.org/contribute/#make-your-change) and mention them in a comment (`R: @username`).
- [ ] Format the pull request title like `[BEAM-XXX] Fixes bug in ApproximateQuantiles`, where you replace `BEAM-XXX` with the appropriate JIRA issue, if applicable. This will automatically link the pull request to the issue.
- [ ] Update `CHANGES.md` with noteworthy changes.
- [ ] If this contribution is large, please file an Apache [Individual Contributor License Agreement](https://www.apache.org/licenses/icla.pdf).
See the [Contributor Guide](https://beam.apache.org/contribute) for more tips on [how to make review process smoother](https://beam.apache.org/contribute/#make-reviewers-job-easier).
To check the build health, please visit [https://github.com/apache/beam/blob/master/.test-infra/BUILD_STATUS.md](https://github.com/apache/beam/blob/master/.test-infra/BUILD_STATUS.md)
GitHub Actions Tests Status (on master branch)
------------------------------------------------------------------------------------------------
[](https://github.com/apache/beam/actions?query=workflow%3A%22Build+python+source+distribution+and+wheels%22+branch%3Amaster+event%3Aschedule)
[](https://github.com/apache/beam/actions?query=workflow%3A%22Python+Tests%22+branch%3Amaster+event%3Aschedule)
[](https://github.com/apache/beam/actions?query=workflow%3A%22Java+Tests%22+branch%3Amaster+event%3Aschedule)
See [CI.md](https://github.com/apache/beam/blob/master/CI.md) for more information about GitHub Actions CI.
--
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: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] bullet03 commented on a change in pull request #17089: [BEAM-13992] [Website] update Contribute/Code Contribution Guide page
Posted by GitBox <gi...@apache.org>.
bullet03 commented on a change in pull request #17089:
URL: https://github.com/apache/beam/pull/17089#discussion_r833172436
##########
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).
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: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] bullet03 commented on a change in pull request #17089: [BEAM-13992] [Website] update Contribute/Code Contribution Guide page
Posted by GitBox <gi...@apache.org>.
bullet03 commented on a change in pull request #17089:
URL: https://github.com/apache/beam/pull/17089#discussion_r833350899
##########
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 dev@beam.apache.org](/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.
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: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] bullet03 commented on a change in pull request #17089: [BEAM-13992] [Website] update Contribute/Code Contribution Guide page
Posted by GitBox <gi...@apache.org>.
bullet03 commented on a change in pull request #17089:
URL: https://github.com/apache/beam/pull/17089#discussion_r838381795
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -50,53 +50,106 @@ There are lots of opportunities to contribute. You can for example:
Cloud Dataflow, etc)
- improve or add IO connectors
- add new transform libraries (statistics, ML, image processing, etc)
- - work on the core programming model (what is a Beam pipeline and how does it
- run?)
+ - work on the core programming model (read more about what a Beam pipeline is and how it runs here in [Documentation](https://beam.apache.org/documentation/basics/))
- improve the developer experience (for example, Windows guides)
- add answers to the [contribution FAQ](
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@beam.apache.org]( https://beam.apache.org/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 [dev@beam.apache.org](/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@beam.apache.org](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 [dev@beam.apache.org mailing list](https://beam.apache.org/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. 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.
+2. Assign the issue to yourself. To get the permission to do so, email
+ the [dev@beam.apache.org 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).
Review comment:
changed
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -50,53 +50,106 @@ There are lots of opportunities to contribute. You can for example:
Cloud Dataflow, etc)
- improve or add IO connectors
- add new transform libraries (statistics, ML, image processing, etc)
- - work on the core programming model (what is a Beam pipeline and how does it
- run?)
+ - work on the core programming model (read more about what a Beam pipeline is and how it runs here in [Documentation](https://beam.apache.org/documentation/basics/))
- improve the developer experience (for example, Windows guides)
- add answers to the [contribution FAQ](
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@beam.apache.org]( https://beam.apache.org/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 [dev@beam.apache.org](/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@beam.apache.org](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 [dev@beam.apache.org mailing list](https://beam.apache.org/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.
Review comment:
changed
--
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: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] dariabezkorovaina commented on a change in pull request #17089: [BEAM-13992] [Website] update Contribute/Code Contribution Guide page
Posted by GitBox <gi...@apache.org>.
dariabezkorovaina commented on a change in pull request #17089:
URL: https://github.com/apache/beam/pull/17089#discussion_r833242317
##########
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 dev@beam.apache.org](/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/).
Review comment:
slack -> Slack
--
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: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] bullet03 commented on a change in pull request #17089: [BEAM-13992] [Website] update Contribute/Code Contribution Guide page
Posted by GitBox <gi...@apache.org>.
bullet03 commented on a change in pull request #17089:
URL: https://github.com/apache/beam/pull/17089#discussion_r838365808
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -140,122 +193,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**:
Review comment:
markdown nested ordered and unordered lists with indents don't work correctly with code blockes inside these symbols ```.
In order to keep with the lists indents, i had to use `  `
There is an exmaple below.
--
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: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] AydarZaynutdinov commented on a change in pull request #17089: [BEAM-13992] [Website] update Contribute/Code Contribution Guide page
Posted by GitBox <gi...@apache.org>.
AydarZaynutdinov commented on a change in pull request #17089:
URL: https://github.com/apache/beam/pull/17089#discussion_r837709363
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -140,122 +193,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
Review comment:
It's better to use these command (like it is written now).
If user want to use `apache beam` in his own project he will need to download it like a dependency. If I am not mistaken by default it is being downloaded to the `~go/src/module/name` folder (`~/go/src/github.com/apache` in our case).
--
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: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] bullet03 commented on a change in pull request #17089: [BEAM-13992] [Website] update Contribute/Code Contribution Guide page
Posted by GitBox <gi...@apache.org>.
bullet03 commented on a change in pull request #17089:
URL: https://github.com/apache/beam/pull/17089#discussion_r838365808
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -140,122 +193,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**:
Review comment:
markdown nested ordered and unordered lists with indents don't work correctly with code blockes inside these symbols ```.
In order to keep with the lists indents, i had to use `  `
There is an example below.
--
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: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] AydarZaynutdinov commented on a change in pull request #17089: [BEAM-13992] [Website] update Contribute/Code Contribution Guide page
Posted by GitBox <gi...@apache.org>.
AydarZaynutdinov commented on a change in pull request #17089:
URL: https://github.com/apache/beam/pull/17089#discussion_r837744020
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -140,122 +193,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
Review comment:
You are right. Let's rewrite this one to:
```
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.
2. Make a fork
3. Clone the forked repository. You can download it anywhere you like.
$ mkdir -p ~/path/to/your/folder
$ cd ~/path/to/your/folder
$ git clone https://github.com/forked/apache/beam
$ cd beam
```
What do you think about this one?
--
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: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] AydarZaynutdinov commented on a change in pull request #17089: [BEAM-13992] [Website] update Contribute/Code Contribution Guide page
Posted by GitBox <gi...@apache.org>.
AydarZaynutdinov commented on a change in pull request #17089:
URL: https://github.com/apache/beam/pull/17089#discussion_r839264209
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -140,122 +193,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> git@github.com:<GitHub_user>/beam.git
- $ git fetch --all
- 1. Get or Update all the Go SDK dependencies
- $ go get -u ./...
-
-1. Check the environment was set up correctly.
- - **Option 1**: validate the Go, Java, and Python environments:
-
- **Important**: Make sure you have activated Python development.
+  We recommend putting it in your `$GOPATH` (`$HOME/go` by default on Unix systems).
Review comment:
Updated.
--
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: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] dariabezkorovaina commented on a change in pull request #17089: [BEAM-13992] [Website] update Contribute/Code Contribution Guide page
Posted by GitBox <gi...@apache.org>.
dariabezkorovaina commented on a change in pull request #17089:
URL: https://github.com/apache/beam/pull/17089#discussion_r833302991
##########
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> git@github.com:<GitHub_user>/beam.git
- $ git fetch --all
- 1. Get or Update all the Go SDK dependencies
- $ go get -u ./...
-
-1. Check the environment was set up correctly.
- - **Option 1**: validate the Go, Java, and Python environments:
-
- **Important**: Make sure you have activated Python development.
+  We recommend putting it in your `$GOPATH` (`$HOME/go` by default on Unix systems).
+
+  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
##########
@@ -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> git@github.com:<GitHub_user>/beam.git
- $ git fetch --all
- 1. Get or Update all the Go SDK dependencies
- $ go get -u ./...
-
-1. Check the environment was set up correctly.
- - **Option 1**: validate the Go, Java, and Python environments:
-
- **Important**: Make sure you have activated Python development.
+  We recommend putting it in your `$GOPATH` (`$HOME/go` by default on Unix systems).
+
+  Clone the repo, and update your branch as normal
+
+
+```
+$ git clone https://github.com/apache/beam.git
+$ cd beam
+$ git remote add <GitHub_user> git@github.com:<GitHub_user>/beam.git
+$ git fetch --all
+```
+
+  Get or Update all the Go SDK dependencies
Review comment:
Add **:** at the end of the line
--
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: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] bullet03 commented on a change in pull request #17089: [BEAM-13992] [Website] update Contribute/Code Contribution Guide page
Posted by GitBox <gi...@apache.org>.
bullet03 commented on a change in pull request #17089:
URL: https://github.com/apache/beam/pull/17089#discussion_r833172223
##########
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.
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)
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: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] dariabezkorovaina commented on a change in pull request #17089: [BEAM-13992] [Website] update Contribute/Code Contribution Guide page
Posted by GitBox <gi...@apache.org>.
dariabezkorovaina commented on a change in pull request #17089:
URL: https://github.com/apache/beam/pull/17089#discussion_r833250417
##########
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 dev@beam.apache.org](/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 [dev@beam.apache.org](/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@beam.apache.org](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 [dev@beam.apache.org 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!
Review comment:
slack-> Slack
--
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: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] AydarZaynutdinov commented on pull request #17089: [BEAM-13992] [Website] update Contribute/Code Contribution Guide page
Posted by GitBox <gi...@apache.org>.
AydarZaynutdinov commented on pull request #17089:
URL: https://github.com/apache/beam/pull/17089#issuecomment-1073818972
is this PR still draft?
--
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: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] bullet03 commented on a change in pull request #17089: [BEAM-13992] [Website] update Contribute/Code Contribution Guide page
Posted by GitBox <gi...@apache.org>.
bullet03 commented on a change in pull request #17089:
URL: https://github.com/apache/beam/pull/17089#discussion_r833367191
##########
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> git@github.com:<GitHub_user>/beam.git
- $ git fetch --all
- 1. Get or Update all the Go SDK dependencies
- $ go get -u ./...
-
-1. Check the environment was set up correctly.
- - **Option 1**: validate the Go, Java, and Python environments:
-
- **Important**: Make sure you have activated Python development.
+  We recommend putting it in your `$GOPATH` (`$HOME/go` by default on Unix systems).
+
+  Clone the repo, and update your branch as normal
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: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] bullet03 commented on a change in pull request #17089: [BEAM-13992] [Website] update Contribute/Code Contribution Guide page
Posted by GitBox <gi...@apache.org>.
bullet03 commented on a change in pull request #17089:
URL: https://github.com/apache/beam/pull/17089#discussion_r833173568
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -160,102 +216,91 @@ script which is part of the Beam repo:
./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.
+<br><br>
-### 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> git@github.com:<GitHub_user>/beam.git
- $ git fetch --all
- 1. Get or Update all the Go SDK dependencies
- $ go get -u ./...
-
-1. Check the environment was set up correctly.
- - **Option 1**: validate the Go, Java, and Python environments:
-
- **Important**: Make sure you have activated Python development.
+  We recommend putting it in your `$GOPATH` (`$HOME/go` by default on Unix systems).
+
+  Clone the repo, and update your branch as normal
+
+
+```
+$ git clone https://github.com/apache/beam.git
+$ cd beam
+$ git remote add <GitHub_user> git@github.com:<GitHub_user>/beam.git
+$ git fetch --all
+```
+
+  Get or Update all the Go SDK dependencies
+ ```
+$ go get -u ./...
+```
+<br>
+
+3. Check the environment was set up correctly.
+
+  **Option 1**: validate the Go, Java, and Python environments:
+
+  **Important**: Make sure you have activated Python development.
```
./gradlew :checkSetup
```
- - **Option 2**: Run independent checks:
- - For **Go development**:
- 1. Execute:
+
+
+  **Option 2**: Run independent checks:
+
+    For **Go development**:
```
-export GOLANG_PROTOBUF_REGISTRATION_CONFLICT=ignore
-./gradlew :sdks:go:examples:wordCount
+export GOLANG_PROTOBUF_REGISTRATION_CONFLICT=ignore./gradlew :sdks:go:examples:wordCount
```
- - For **Python development**:
- 1. Execute:
+    For **Python development**:
```
./gradlew :sdks:python:wordCount
```
- - For **Java development**:
- 1. Execute:
+    For **Java development**:
```
./gradlew :examples:java:wordCount
```
+<br>
-1. Familiarize yourself with gradle and the project structure. At the root of the git repository, run:
-
- $ ./gradlew projects
-
+4. Familiarize yourself with gradle and the project structure. At the root of the git repository, run:
Review comment:
done
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -160,102 +216,91 @@ script which is part of the Beam repo:
./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.
+<br><br>
-### 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> git@github.com:<GitHub_user>/beam.git
- $ git fetch --all
- 1. Get or Update all the Go SDK dependencies
- $ go get -u ./...
-
-1. Check the environment was set up correctly.
- - **Option 1**: validate the Go, Java, and Python environments:
-
- **Important**: Make sure you have activated Python development.
+  We recommend putting it in your `$GOPATH` (`$HOME/go` by default on Unix systems).
+
+  Clone the repo, and update your branch as normal
+
+
+```
+$ git clone https://github.com/apache/beam.git
+$ cd beam
+$ git remote add <GitHub_user> git@github.com:<GitHub_user>/beam.git
+$ git fetch --all
+```
+
+  Get or Update all the Go SDK dependencies
+ ```
+$ go get -u ./...
+```
+<br>
+
+3. Check the environment was set up correctly.
+
+  **Option 1**: validate the Go, Java, and Python environments:
+
+  **Important**: Make sure you have activated Python development.
```
./gradlew :checkSetup
```
- - **Option 2**: Run independent checks:
- - For **Go development**:
- 1. Execute:
+
+
+  **Option 2**: Run independent checks:
+
+    For **Go development**:
```
-export GOLANG_PROTOBUF_REGISTRATION_CONFLICT=ignore
-./gradlew :sdks:go:examples:wordCount
+export GOLANG_PROTOBUF_REGISTRATION_CONFLICT=ignore./gradlew :sdks:go:examples:wordCount
```
- - For **Python development**:
- 1. Execute:
+    For **Python development**:
```
./gradlew :sdks:python:wordCount
```
- - For **Java development**:
- 1. Execute:
+    For **Java development**:
```
./gradlew :examples:java:wordCount
```
+<br>
-1. Familiarize yourself with gradle and the project structure. At the root of the git repository, run:
-
- $ ./gradlew projects
-
+4. Familiarize yourself with gradle and the project structure. At the root of the git repository, run:
+ ```
+$ ./gradlew projects
+ ```
Examine the available tasks in a project. For the default set of tasks, use:
Review comment:
done
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -160,102 +216,91 @@ script which is part of the Beam repo:
./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.
+<br><br>
-### 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> git@github.com:<GitHub_user>/beam.git
- $ git fetch --all
- 1. Get or Update all the Go SDK dependencies
- $ go get -u ./...
-
-1. Check the environment was set up correctly.
- - **Option 1**: validate the Go, Java, and Python environments:
-
- **Important**: Make sure you have activated Python development.
+  We recommend putting it in your `$GOPATH` (`$HOME/go` by default on Unix systems).
+
+  Clone the repo, and update your branch as normal
+
+
+```
+$ git clone https://github.com/apache/beam.git
+$ cd beam
+$ git remote add <GitHub_user> git@github.com:<GitHub_user>/beam.git
+$ git fetch --all
+```
+
+  Get or Update all the Go SDK dependencies
+ ```
+$ go get -u ./...
+```
+<br>
+
+3. Check the environment was set up correctly.
+
+  **Option 1**: validate the Go, Java, and Python environments:
+
+  **Important**: Make sure you have activated Python development.
```
./gradlew :checkSetup
```
- - **Option 2**: Run independent checks:
- - For **Go development**:
- 1. Execute:
+
+
+  **Option 2**: Run independent checks:
+
+    For **Go development**:
```
-export GOLANG_PROTOBUF_REGISTRATION_CONFLICT=ignore
-./gradlew :sdks:go:examples:wordCount
+export GOLANG_PROTOBUF_REGISTRATION_CONFLICT=ignore./gradlew :sdks:go:examples:wordCount
```
- - For **Python development**:
- 1. Execute:
+    For **Python development**:
```
./gradlew :sdks:python:wordCount
```
- - For **Java development**:
- 1. Execute:
+    For **Java development**:
```
./gradlew :examples:java:wordCount
```
+<br>
-1. Familiarize yourself with gradle and the project structure. At the root of the git repository, run:
-
- $ ./gradlew projects
-
+4. Familiarize yourself with gradle and the project structure. At the root of the git repository, run:
+ ```
+$ ./gradlew projects
+ ```
Examine the available tasks in a project. For the default set of tasks, use:
-
- $ ./gradlew tasks
-
+ ```
+$ ./gradlew tasks
+ ```
For a given module, use:
Review comment:
done
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -160,102 +216,91 @@ script which is part of the Beam repo:
./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.
+<br><br>
-### 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> git@github.com:<GitHub_user>/beam.git
- $ git fetch --all
- 1. Get or Update all the Go SDK dependencies
- $ go get -u ./...
-
-1. Check the environment was set up correctly.
- - **Option 1**: validate the Go, Java, and Python environments:
-
- **Important**: Make sure you have activated Python development.
+  We recommend putting it in your `$GOPATH` (`$HOME/go` by default on Unix systems).
+
+  Clone the repo, and update your branch as normal
+
+
+```
+$ git clone https://github.com/apache/beam.git
+$ cd beam
+$ git remote add <GitHub_user> git@github.com:<GitHub_user>/beam.git
+$ git fetch --all
+```
+
+  Get or Update all the Go SDK dependencies
+ ```
+$ go get -u ./...
+```
+<br>
+
+3. Check the environment was set up correctly.
+
+  **Option 1**: validate the Go, Java, and Python environments:
+
+  **Important**: Make sure you have activated Python development.
```
./gradlew :checkSetup
```
- - **Option 2**: Run independent checks:
- - For **Go development**:
- 1. Execute:
+
+
+  **Option 2**: Run independent checks:
+
+    For **Go development**:
```
-export GOLANG_PROTOBUF_REGISTRATION_CONFLICT=ignore
-./gradlew :sdks:go:examples:wordCount
+export GOLANG_PROTOBUF_REGISTRATION_CONFLICT=ignore./gradlew :sdks:go:examples:wordCount
```
- - For **Python development**:
- 1. Execute:
+    For **Python development**:
```
./gradlew :sdks:python:wordCount
```
- - For **Java development**:
- 1. Execute:
+    For **Java development**:
```
./gradlew :examples:java:wordCount
```
+<br>
-1. Familiarize yourself with gradle and the project structure. At the root of the git repository, run:
-
- $ ./gradlew projects
-
+4. Familiarize yourself with gradle and the project structure. At the root of the git repository, run:
+ ```
+$ ./gradlew projects
+ ```
Examine the available tasks in a project. For the default set of tasks, use:
-
- $ ./gradlew tasks
-
+ ```
+$ ./gradlew tasks
+ ```
For a given module, use:
-
- $ ./gradlew -p sdks/java/io/cassandra tasks
-
- For an exhaustive list of tasks, use:
-
- $ ./gradlew tasks --all
-
-1. Make sure you can build and run tests
+ ```
+$ ./gradlew -p sdks/java/io/cassandra tasks
+ ```
+ For an exhaustive list of tasks, use:
Review comment:
done
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -160,102 +216,91 @@ script which is part of the Beam repo:
./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.
+<br><br>
-### 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> git@github.com:<GitHub_user>/beam.git
- $ git fetch --all
- 1. Get or Update all the Go SDK dependencies
- $ go get -u ./...
-
-1. Check the environment was set up correctly.
- - **Option 1**: validate the Go, Java, and Python environments:
-
- **Important**: Make sure you have activated Python development.
+  We recommend putting it in your `$GOPATH` (`$HOME/go` by default on Unix systems).
+
+  Clone the repo, and update your branch as normal
+
+
+```
+$ git clone https://github.com/apache/beam.git
+$ cd beam
+$ git remote add <GitHub_user> git@github.com:<GitHub_user>/beam.git
+$ git fetch --all
+```
+
+  Get or Update all the Go SDK dependencies
+ ```
+$ go get -u ./...
+```
+<br>
+
+3. Check the environment was set up correctly.
+
+  **Option 1**: validate the Go, Java, and Python environments:
+
+  **Important**: Make sure you have activated Python development.
```
./gradlew :checkSetup
```
- - **Option 2**: Run independent checks:
- - For **Go development**:
- 1. Execute:
+
+
+  **Option 2**: Run independent checks:
+
+    For **Go development**:
```
-export GOLANG_PROTOBUF_REGISTRATION_CONFLICT=ignore
-./gradlew :sdks:go:examples:wordCount
+export GOLANG_PROTOBUF_REGISTRATION_CONFLICT=ignore./gradlew :sdks:go:examples:wordCount
```
- - For **Python development**:
- 1. Execute:
+    For **Python development**:
```
./gradlew :sdks:python:wordCount
```
- - For **Java development**:
- 1. Execute:
+    For **Java development**:
```
./gradlew :examples:java:wordCount
```
+<br>
-1. Familiarize yourself with gradle and the project structure. At the root of the git repository, run:
-
- $ ./gradlew projects
-
+4. Familiarize yourself with gradle and the project structure. At the root of the git repository, run:
+ ```
+$ ./gradlew projects
+ ```
Examine the available tasks in a project. For the default set of tasks, use:
-
- $ ./gradlew tasks
-
+ ```
+$ ./gradlew tasks
+ ```
For a given module, use:
-
- $ ./gradlew -p sdks/java/io/cassandra tasks
-
- For an exhaustive list of tasks, use:
-
- $ ./gradlew tasks --all
-
-1. Make sure you can build and run tests
+ ```
+$ ./gradlew -p sdks/java/io/cassandra tasks
+ ```
+ For an exhaustive list of tasks, use:
+ ```
+$ ./gradlew tasks --all
+ ```
+5. Make sure you can build and run tests
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: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] bullet03 commented on a change in pull request #17089: [BEAM-13992] [Website] update Contribute/Code Contribution Guide page
Posted by GitBox <gi...@apache.org>.
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: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] bullet03 commented on a change in pull request #17089: [BEAM-13992] [Website] update Contribute/Code Contribution Guide page
Posted by GitBox <gi...@apache.org>.
bullet03 commented on a change in pull request #17089:
URL: https://github.com/apache/beam/pull/17089#discussion_r830065630
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -160,102 +216,91 @@ script which is part of the Beam repo:
./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.
+<br><br>
-### 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> git@github.com:<GitHub_user>/beam.git
- $ git fetch --all
- 1. Get or Update all the Go SDK dependencies
- $ go get -u ./...
-
-1. Check the environment was set up correctly.
- - **Option 1**: validate the Go, Java, and Python environments:
-
- **Important**: Make sure you have activated Python development.
+  We recommend putting it in your `$GOPATH` (`$HOME/go` by default on Unix systems).
Review comment:
done
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -321,69 +374,38 @@ 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).
+### Troubleshooting
-- [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!
+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/).
-## Additional resources
+If you didn't find the information you were looking for in this guide, please
+[reach out to the Beam community](/community/contact-us).
-If you are contributing a `PTransform` to Beam, we have an extensive
-[PTransform Style Guide](/contribute/ptransform-style-guide).
+</div>
-If you are contributing a Runner to Beam, refer to the
-[Runner authoring guide](/contribute/runner-guide/)
+## 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).
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
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
Review comment:
done
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -321,69 +374,38 @@ 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).
+### Troubleshooting
-- [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!
+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/).
-## Additional resources
+If you didn't find the information you were looking for in this guide, please
+[reach out to the Beam community](/community/contact-us).
-If you are contributing a `PTransform` to Beam, we have an extensive
-[PTransform Style Guide](/contribute/ptransform-style-guide).
+</div>
-If you are contributing a Runner to Beam, refer to the
-[Runner authoring guide](/contribute/runner-guide/)
+## 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/).
+## Other Resources
Review comment:
done
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -321,69 +374,38 @@ 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).
+### Troubleshooting
-- [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!
+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/).
-## Additional resources
+If you didn't find the information you were looking for in this guide, please
+[reach out to the Beam community](/community/contact-us).
-If you are contributing a `PTransform` to Beam, we have an extensive
-[PTransform Style Guide](/contribute/ptransform-style-guide).
+</div>
-If you are contributing a Runner to Beam, refer to the
-[Runner authoring guide](/contribute/runner-guide/)
+## 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/).
+## Other Resources
+Please see Beam developers’ Wiki Contributor FAQ for more information.
+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:
done
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -321,69 +374,38 @@ 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).
+### Troubleshooting
-- [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!
+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/).
-## Additional resources
+If you didn't find the information you were looking for in this guide, please
+[reach out to the Beam community](/community/contact-us).
-If you are contributing a `PTransform` to Beam, we have an extensive
-[PTransform Style Guide](/contribute/ptransform-style-guide).
+</div>
-If you are contributing a Runner to Beam, refer to the
-[Runner authoring guide](/contribute/runner-guide/)
+## 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/).
+## Other Resources
+Please see Beam developers’ Wiki Contributor FAQ for more information.
+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).
+If you are contributing a Runner to Beam, refer to the [Runner authoring guide](https://beam.apache.org/contribute/runner-guide/).
Review comment:
done
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -321,69 +374,38 @@ 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).
+### Troubleshooting
-- [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!
+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/).
-## Additional resources
+If you didn't find the information you were looking for in this guide, please
+[reach out to the Beam community](/community/contact-us).
-If you are contributing a `PTransform` to Beam, we have an extensive
-[PTransform Style Guide](/contribute/ptransform-style-guide).
+</div>
-If you are contributing a Runner to Beam, refer to the
-[Runner authoring guide](/contribute/runner-guide/)
+## 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/).
+## Other Resources
+Please see Beam developers’ Wiki Contributor FAQ for more information.
+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).
+If you are contributing a Runner to Beam, refer to the [Runner authoring guide](https://beam.apache.org/contribute/runner-guide/).
Review [design documents](https://s.apache.org/beam-design-docs).
Review comment:
done
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -321,69 +374,38 @@ 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).
+### Troubleshooting
-- [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!
+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/).
-## Additional resources
+If you didn't find the information you were looking for in this guide, please
+[reach out to the Beam community](/community/contact-us).
-If you are contributing a `PTransform` to Beam, we have an extensive
-[PTransform Style Guide](/contribute/ptransform-style-guide).
+</div>
-If you are contributing a Runner to Beam, refer to the
-[Runner authoring guide](/contribute/runner-guide/)
+## 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/).
+## Other Resources
+Please see Beam developers’ Wiki Contributor FAQ for more information.
+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).
+If you are contributing a Runner to Beam, refer to the [Runner authoring guide](https://beam.apache.org/contribute/runner-guide/).
Review [design documents](https://s.apache.org/beam-design-docs).
-
-A great way to contribute is to join an existing effort. For the most
-intensive efforts, check out the [roadmap](/roadmap/).
-
-You can also find a more exhaustive list on the [Beam developers' wiki](
-https://cwiki.apache.org/confluence/display/BEAM/Apache+Beam)
-
-## Troubleshooting
-
-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/).
-
-If you didn't find the information you were looking for in this guide, please
-[reach out to the Beam community](/community/contact-us).
+You can also find out more information on the [Beam developers’ Wiki](
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: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] bullet03 commented on a change in pull request #17089: [BEAM-13992] [Website] update Contribute/Code Contribution Guide page
Posted by GitBox <gi...@apache.org>.
bullet03 commented on a change in pull request #17089:
URL: https://github.com/apache/beam/pull/17089#discussion_r838381695
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -140,122 +193,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
Review comment:
changed
--
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: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] bullet03 commented on a change in pull request #17089: [BEAM-13992] [Website] update Contribute/Code Contribution Guide page
Posted by GitBox <gi...@apache.org>.
bullet03 commented on a change in pull request #17089:
URL: https://github.com/apache/beam/pull/17089#discussion_r833174274
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -285,12 +335,15 @@ export GOLANG_PROTOBUF_REGISTRATION_CONFLICT=ignore
jobs](https://cwiki.apache.org/confluence/display/BEAM/Contribution+Testing+Guide#ContributionTestingGuide-Pre-commit). If a test fails and appears unrelated to your
change, you can cause tests to be re-run by adding a single line comment on your
PR
Review comment:
done
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -303,7 +356,7 @@ export GOLANG_PROTOBUF_REGISTRATION_CONFLICT=ignore
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.
-### Make the reviewer's job easier
+#### Make the reviewer's job easier
Review comment:
done
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -303,7 +356,7 @@ export GOLANG_PROTOBUF_REGISTRATION_CONFLICT=ignore
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
Review comment:
done
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -321,69 +374,38 @@ 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
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: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] dariabezkorovaina commented on a change in pull request #17089: [BEAM-13992] [Website] update Contribute/Code Contribution Guide page
Posted by GitBox <gi...@apache.org>.
dariabezkorovaina commented on a change in pull request #17089:
URL: https://github.com/apache/beam/pull/17089#discussion_r837080009
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -57,46 +57,100 @@ There are lots of opportunities to contribute. You can for example:
https://cwiki.apache.org/confluence/display/BEAM/Contributor+FAQ)
Review comment:
(what is a Beam pipeline and how does it run?) -> (read more about what a Beam pipeline is and how it runs [here in Documentation](https://beam.apache.org/documentation/basics/))
--
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: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] bullet03 commented on a change in pull request #17089: [BEAM-13992] [Website] update Contribute/Code Contribution Guide page
Posted by GitBox <gi...@apache.org>.
bullet03 commented on a change in pull request #17089:
URL: https://github.com/apache/beam/pull/17089#discussion_r838365535
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -140,122 +193,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> git@github.com:<GitHub_user>/beam.git
- $ git fetch --all
- 1. Get or Update all the Go SDK dependencies
- $ go get -u ./...
-
-1. Check the environment was set up correctly.
- - **Option 1**: validate the Go, Java, and Python environments:
-
- **Important**: Make sure you have activated Python development.
+  We recommend putting it in your `$GOPATH` (`$HOME/go` by default on Unix systems).
Review comment:
markdown nested ordered and unordered lists with indents don't work correctly with code blockes inside these symbols ```.
In order to keep with the lists indents, i had to use `  `
--
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: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] bullet03 commented on a change in pull request #17089: [BEAM-13992] [Website] update Contribute/Code Contribution Guide page
Posted by GitBox <gi...@apache.org>.
bullet03 commented on a change in pull request #17089:
URL: https://github.com/apache/beam/pull/17089#discussion_r838365808
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -140,122 +193,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**:
Review comment:
markdown nested ordered and unordered lists with indents don't work correctly with code blockes inside these symbols ```.
In order to keep with the lists indents, i had to use `  `
There is an exaьple below.
--
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: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] AydarZaynutdinov edited a comment on pull request #17089: [BEAM-13992] [Website] update Contribute/Code Contribution Guide page
Posted by GitBox <gi...@apache.org>.
AydarZaynutdinov edited a comment on pull request #17089:
URL: https://github.com/apache/beam/pull/17089#issuecomment-1073818972
@bullet03 Is this PR still draft?
--
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: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] pcoet commented on a change in pull request #17089: [BEAM-13992] [Website] update Contribute/Code Contribution Guide page
Posted by GitBox <gi...@apache.org>.
pcoet commented on a change in pull request #17089:
URL: https://github.com/apache/beam/pull/17089#discussion_r837681442
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -50,53 +50,106 @@ There are lots of opportunities to contribute. You can for example:
Cloud Dataflow, etc)
- improve or add IO connectors
- add new transform libraries (statistics, ML, image processing, etc)
- - work on the core programming model (what is a Beam pipeline and how does it
- run?)
+ - work on the core programming model (read more about what a Beam pipeline is and how it runs here in [Documentation](https://beam.apache.org/documentation/basics/))
- improve the developer experience (for example, Windows guides)
- add answers to the [contribution FAQ](
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@beam.apache.org]( https://beam.apache.org/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.
Review comment:
Extra space here: "( https:". I'm pretty sure the Markdown parser will ignore that, but ... FYI.
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -50,53 +50,106 @@ There are lots of opportunities to contribute. You can for example:
Cloud Dataflow, etc)
- improve or add IO connectors
- add new transform libraries (statistics, ML, image processing, etc)
- - work on the core programming model (what is a Beam pipeline and how does it
- run?)
+ - work on the core programming model (read more about what a Beam pipeline is and how it runs here in [Documentation](https://beam.apache.org/documentation/basics/))
- improve the developer experience (for example, Windows guides)
- add answers to the [contribution FAQ](
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@beam.apache.org]( https://beam.apache.org/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 [dev@beam.apache.org](/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@beam.apache.org](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 [dev@beam.apache.org mailing list](https://beam.apache.org/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.
Review comment:
"testing this website changes" -> "testing changes to this website"
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -140,122 +193,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**:
Review comment:
Is there a reason that we're using HTML entities in Markdown?
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -50,53 +50,106 @@ There are lots of opportunities to contribute. You can for example:
Cloud Dataflow, etc)
- improve or add IO connectors
- add new transform libraries (statistics, ML, image processing, etc)
- - work on the core programming model (what is a Beam pipeline and how does it
- run?)
+ - work on the core programming model (read more about what a Beam pipeline is and how it runs here in [Documentation](https://beam.apache.org/documentation/basics/))
- improve the developer experience (for example, Windows guides)
- add answers to the [contribution FAQ](
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@beam.apache.org]( https://beam.apache.org/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 [dev@beam.apache.org](/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@beam.apache.org](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 [dev@beam.apache.org mailing list](https://beam.apache.org/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. 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.
+2. Assign the issue to yourself. To get the permission to do so, email
+ the [dev@beam.apache.org 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).
Review comment:
"For example [this" -> "For example, see [this"
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -140,122 +193,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
Review comment:
Is this to ensure that the Beam is on the Go path? Otherwise I don't understand why you'd be creating a new directory path under `~/go`... I've always followed these steps: https://cwiki.apache.org/confluence/display/BEAM/Git+Tips
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -50,53 +50,106 @@ There are lots of opportunities to contribute. You can for example:
Cloud Dataflow, etc)
- improve or add IO connectors
- add new transform libraries (statistics, ML, image processing, etc)
- - work on the core programming model (what is a Beam pipeline and how does it
- run?)
+ - work on the core programming model (read more about what a Beam pipeline is and how it runs here in [Documentation](https://beam.apache.org/documentation/basics/))
- improve the developer experience (for example, Windows guides)
- add answers to the [contribution FAQ](
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@beam.apache.org]( https://beam.apache.org/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 [dev@beam.apache.org](/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@beam.apache.org](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 [dev@beam.apache.org mailing list](https://beam.apache.org/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. 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.
Review comment:
"may find" -> "can find"
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -140,122 +193,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> git@github.com:<GitHub_user>/beam.git
- $ git fetch --all
- 1. Get or Update all the Go SDK dependencies
- $ go get -u ./...
-
-1. Check the environment was set up correctly.
- - **Option 1**: validate the Go, Java, and Python environments:
-
- **Important**: Make sure you have activated Python development.
+  We recommend putting it in your `$GOPATH` (`$HOME/go` by default on Unix systems).
Review comment:
Do we need these entities? And all the following entities? It's usually possible to get a the indentation that you want using lists...
--
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: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] bullet03 commented on a change in pull request #17089: [BEAM-13992] [Website] update Contribute/Code Contribution Guide page
Posted by GitBox <gi...@apache.org>.
bullet03 commented on a change in pull request #17089:
URL: https://github.com/apache/beam/pull/17089#discussion_r838365808
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -140,122 +193,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**:
Review comment:
Nested ordered and unordered lists don't work correctly. If I use markdowns only (code example) I receive a result with incorrect indents (like you can see in the screenshoot in comment below). So that's why I use ` `
Is it ok?
--
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: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] bullet03 commented on a change in pull request #17089: [BEAM-13992] [Website] update Contribute/Code Contribution Guide page
Posted by GitBox <gi...@apache.org>.
bullet03 commented on a change in pull request #17089:
URL: https://github.com/apache/beam/pull/17089#discussion_r833366247
##########
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 [dev@beam.apache.org mailing list](/community/contact-us) to ask for someone to look at your pull request.
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: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] bullet03 commented on a change in pull request #17089: [BEAM-13992] [Website] update Contribute/Code Contribution Guide page
Posted by GitBox <gi...@apache.org>.
bullet03 commented on a change in pull request #17089:
URL: https://github.com/apache/beam/pull/17089#discussion_r833131197
##########
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).
+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).
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: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] bullet03 commented on a change in pull request #17089: [BEAM-13992] [Website] update Contribute/Code Contribution Guide page
Posted by GitBox <gi...@apache.org>.
bullet03 commented on a change in pull request #17089:
URL: https://github.com/apache/beam/pull/17089#discussion_r833130760
##########
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).
+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/).
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: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] bullet03 commented on a change in pull request #17089: [BEAM-13992] [Website] update Contribute/Code Contribution Guide page
Posted by GitBox <gi...@apache.org>.
bullet03 commented on a change in pull request #17089:
URL: https://github.com/apache/beam/pull/17089#discussion_r833352734
##########
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 dev@beam.apache.org](/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 [dev@beam.apache.org](/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@beam.apache.org](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 [dev@beam.apache.org 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 [dev@beam.apache.org 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 dev@beam.apache.org 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 [dev@beam.apache.org mailing list](https://beam.apache.org/community/contact-us/).
+
+### Setup Your Environment
+
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: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] bullet03 commented on a change in pull request #17089: [BEAM-13992] [Website] update Contribute/Code Contribution Guide page
Posted by GitBox <gi...@apache.org>.
bullet03 commented on a change in pull request #17089:
URL: https://github.com/apache/beam/pull/17089#discussion_r833350167
##########
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 dev@beam.apache.org](/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/).
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: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] bullet03 commented on a change in pull request #17089: [BEAM-13992] [Website] update Contribute/Code Contribution Guide page
Posted by GitBox <gi...@apache.org>.
bullet03 commented on a change in pull request #17089:
URL: https://github.com/apache/beam/pull/17089#discussion_r838365535
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -140,122 +193,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> git@github.com:<GitHub_user>/beam.git
- $ git fetch --all
- 1. Get or Update all the Go SDK dependencies
- $ go get -u ./...
-
-1. Check the environment was set up correctly.
- - **Option 1**: validate the Go, Java, and Python environments:
-
- **Important**: Make sure you have activated Python development.
+  We recommend putting it in your `$GOPATH` (`$HOME/go` by default on Unix systems).
Review comment:
Nested ordered and unordered lists don't work correctly. If I use markdowns only (code example) I receive a result with incorrect indents (like you can see in the screenshoot). So that's why I use ` `
Is it ok?
--
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: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] AydarZaynutdinov commented on a change in pull request #17089: [BEAM-13992] [Website] update Contribute/Code Contribution Guide page
Posted by GitBox <gi...@apache.org>.
AydarZaynutdinov commented on a change in pull request #17089:
URL: https://github.com/apache/beam/pull/17089#discussion_r837711438
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -140,122 +193,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
Review comment:
Alternatively, if we want to state that people need to download the repo right away, we can change the code to:
```
$ mkdir -p ~/path/to/your/folder
$ cd ~/path/to/your/folder
$ git clone https://github.com/apache/beam
$ cd beam
```
Please LMK which option works better in your opinion.
--
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: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] AydarZaynutdinov commented on a change in pull request #17089: [BEAM-13992] [Website] update Contribute/Code Contribution Guide page
Posted by GitBox <gi...@apache.org>.
AydarZaynutdinov commented on a change in pull request #17089:
URL: https://github.com/apache/beam/pull/17089#discussion_r837744020
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -140,122 +193,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
Review comment:
You are right. Let's rewrite this one to:
```
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.
2. Make a fork of https://github.com/apache/beam repo.
3. Clone the forked repository. You can download it anywhere you like.
$ mkdir -p ~/path/to/your/folder
$ cd ~/path/to/your/folder
$ git clone https://github.com/forked/apache/beam
$ cd beam
```
What do you think about this one?
--
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: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] dariabezkorovaina commented on a change in pull request #17089: [BEAM-13992] [Website] update Contribute/Code Contribution Guide page
Posted by GitBox <gi...@apache.org>.
dariabezkorovaina commented on a change in pull request #17089:
URL: https://github.com/apache/beam/pull/17089#discussion_r833253979
##########
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 dev@beam.apache.org](/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 [dev@beam.apache.org](/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@beam.apache.org](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 [dev@beam.apache.org 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
##########
@@ -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 dev@beam.apache.org](/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 [dev@beam.apache.org](/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@beam.apache.org](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 [dev@beam.apache.org 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
##########
@@ -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 dev@beam.apache.org](/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 [dev@beam.apache.org](/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@beam.apache.org](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 [dev@beam.apache.org 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
--
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: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] bullet03 commented on a change in pull request #17089: [BEAM-13992] [Website] update Contribute/Code Contribution Guide page
Posted by GitBox <gi...@apache.org>.
bullet03 commented on a change in pull request #17089:
URL: https://github.com/apache/beam/pull/17089#discussion_r833173033
##########
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).
+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).
+
+### Setup Your Environment
+
+#### Configuration Options
You have two options for configuring your development environment:
- Local:
- - Manually installing the prerequisites listed above.
- - Using the automated script for Linux and macOS.
-- Container: using a Docker image.
+ - Manually installing the [prerequisites](https://beam.apache.org/contribute/#prerequisites).
+ - Using the automated script for Linux and macOS.
+- Container: using a [Docker](https://www.docker.com/) image.
Review comment:
done
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -147,7 +203,7 @@ To install:
./local-env-setup.sh
Review comment:
done
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -160,102 +216,91 @@ script which is part of the Beam repo:
./start-build-env.sh
Review comment:
done
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -160,102 +216,91 @@ script which is part of the Beam repo:
./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.
+<br><br>
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: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] bullet03 commented on a change in pull request #17089: [BEAM-13992] [Website] update Contribute/Code Contribution Guide page
Posted by GitBox <gi...@apache.org>.
bullet03 commented on a change in pull request #17089:
URL: https://github.com/apache/beam/pull/17089#discussion_r833366382
##########
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:
done
##########
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:
done
##########
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:
done
##########
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:
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: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] bullet03 commented on a change in pull request #17089: [BEAM-13992] [Website] update Contribute/Code Contribution Guide page
Posted by GitBox <gi...@apache.org>.
bullet03 commented on a change in pull request #17089:
URL: https://github.com/apache/beam/pull/17089#discussion_r833130304
##########
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).
+1. Assign the issue to yourself. To get the permission to do so, email
+ the [dev@ mailing list](/community/contact-us)
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: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] AydarZaynutdinov commented on a change in pull request #17089: [BEAM-13992] [Website] update Contribute/Code Contribution Guide page
Posted by GitBox <gi...@apache.org>.
AydarZaynutdinov commented on a change in pull request #17089:
URL: https://github.com/apache/beam/pull/17089#discussion_r829858083
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -160,102 +216,91 @@ script which is part of the Beam repo:
./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.
+<br><br>
-### 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> git@github.com:<GitHub_user>/beam.git
- $ git fetch --all
- 1. Get or Update all the Go SDK dependencies
- $ go get -u ./...
-
-1. Check the environment was set up correctly.
- - **Option 1**: validate the Go, Java, and Python environments:
-
- **Important**: Make sure you have activated Python development.
+  We recommend putting it in your `$GOPATH` (`$HOME/go` by default on Unix systems).
Review comment:
```suggestion
  We recommend putting it in your `$GOPATH` (`$HOME/go` by default on Unix systems).
```
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -321,69 +374,38 @@ 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).
+### Troubleshooting
-- [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!
+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/).
-## Additional resources
+If you didn't find the information you were looking for in this guide, please
+[reach out to the Beam community](/community/contact-us).
-If you are contributing a `PTransform` to Beam, we have an extensive
-[PTransform Style Guide](/contribute/ptransform-style-guide).
+</div>
-If you are contributing a Runner to Beam, refer to the
-[Runner authoring guide](/contribute/runner-guide/)
+## 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).
Review comment:
```suggestion
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).
```
##########
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.
Review comment:
```suggestion
- A [GitHub](https://github.com/) account.
```
##########
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).
+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/).
Review comment:
```suggestion
[discuss it on the dev@beam.apache.org mailing list](/community/contact-us/).
```
##########
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).
Review comment:
```suggestion
[dev@beam.apache.org mailing list](/community/contact-us) (include your Wiki account user ID).
```
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -160,102 +216,91 @@ script which is part of the Beam repo:
./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.
+<br><br>
-### 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> git@github.com:<GitHub_user>/beam.git
- $ git fetch --all
- 1. Get or Update all the Go SDK dependencies
- $ go get -u ./...
-
-1. Check the environment was set up correctly.
- - **Option 1**: validate the Go, Java, and Python environments:
-
- **Important**: Make sure you have activated Python development.
+  We recommend putting it in your `$GOPATH` (`$HOME/go` by default on Unix systems).
+
+  Clone the repo, and update your branch as normal
+
+
+```
+$ git clone https://github.com/apache/beam.git
+$ cd beam
+$ git remote add <GitHub_user> git@github.com:<GitHub_user>/beam.git
+$ git fetch --all
+```
+
+  Get or Update all the Go SDK dependencies
+ ```
+$ go get -u ./...
+```
+<br>
+
+3. Check the environment was set up correctly.
+
+  **Option 1**: validate the Go, Java, and Python environments:
+
+  **Important**: Make sure you have activated Python development.
```
./gradlew :checkSetup
```
- - **Option 2**: Run independent checks:
- - For **Go development**:
- 1. Execute:
+
+
+  **Option 2**: Run independent checks:
+
+    For **Go development**:
```
-export GOLANG_PROTOBUF_REGISTRATION_CONFLICT=ignore
-./gradlew :sdks:go:examples:wordCount
+export GOLANG_PROTOBUF_REGISTRATION_CONFLICT=ignore./gradlew :sdks:go:examples:wordCount
```
- - For **Python development**:
- 1. Execute:
+    For **Python development**:
```
./gradlew :sdks:python:wordCount
```
- - For **Java development**:
- 1. Execute:
+    For **Java development**:
```
./gradlew :examples:java:wordCount
```
+<br>
-1. Familiarize yourself with gradle and the project structure. At the root of the git repository, run:
-
- $ ./gradlew projects
-
+4. Familiarize yourself with gradle and the project structure. At the root of the git repository, run:
+ ```
+$ ./gradlew projects
+ ```
Examine the available tasks in a project. For the default set of tasks, use:
-
- $ ./gradlew tasks
-
+ ```
+$ ./gradlew tasks
+ ```
For a given module, use:
-
- $ ./gradlew -p sdks/java/io/cassandra tasks
-
- For an exhaustive list of tasks, use:
-
- $ ./gradlew tasks --all
-
-1. Make sure you can build and run tests
+ ```
+$ ./gradlew -p sdks/java/io/cassandra tasks
+ ```
+ For an exhaustive list of tasks, use:
+ ```
+$ ./gradlew tasks --all
+ ```
+5. Make sure you can build and run tests
Review comment:
```suggestion
5. Make sure you can build and run tests.
```
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -160,102 +216,91 @@ script which is part of the Beam repo:
./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.
+<br><br>
-### 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> git@github.com:<GitHub_user>/beam.git
- $ git fetch --all
- 1. Get or Update all the Go SDK dependencies
- $ go get -u ./...
-
-1. Check the environment was set up correctly.
- - **Option 1**: validate the Go, Java, and Python environments:
-
- **Important**: Make sure you have activated Python development.
+  We recommend putting it in your `$GOPATH` (`$HOME/go` by default on Unix systems).
+
+  Clone the repo, and update your branch as normal
+
+
+```
+$ git clone https://github.com/apache/beam.git
+$ cd beam
+$ git remote add <GitHub_user> git@github.com:<GitHub_user>/beam.git
+$ git fetch --all
+```
+
+  Get or Update all the Go SDK dependencies
+ ```
+$ go get -u ./...
+```
+<br>
+
+3. Check the environment was set up correctly.
+
+  **Option 1**: validate the Go, Java, and Python environments:
+
+  **Important**: Make sure you have activated Python development.
```
./gradlew :checkSetup
```
- - **Option 2**: Run independent checks:
- - For **Go development**:
- 1. Execute:
+
+
+  **Option 2**: Run independent checks:
+
+    For **Go development**:
```
-export GOLANG_PROTOBUF_REGISTRATION_CONFLICT=ignore
-./gradlew :sdks:go:examples:wordCount
+export GOLANG_PROTOBUF_REGISTRATION_CONFLICT=ignore./gradlew :sdks:go:examples:wordCount
```
- - For **Python development**:
- 1. Execute:
+    For **Python development**:
```
./gradlew :sdks:python:wordCount
```
- - For **Java development**:
- 1. Execute:
+    For **Java development**:
```
./gradlew :examples:java:wordCount
```
+<br>
-1. Familiarize yourself with gradle and the project structure. At the root of the git repository, run:
-
- $ ./gradlew projects
-
+4. Familiarize yourself with gradle and the project structure. At the root of the git repository, run:
+ ```
+$ ./gradlew projects
+ ```
Examine the available tasks in a project. For the default set of tasks, use:
-
- $ ./gradlew tasks
-
+ ```
+$ ./gradlew tasks
+ ```
For a given module, use:
Review comment:
```suggestion
  For a given module, use:
```
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -321,69 +374,38 @@ 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
Review comment:
```suggestion
#### Stale Pull Requests
```
##########
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
Review comment:
```suggestion
### Connect with the Beam Community
```
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -35,7 +35,7 @@ limitations under the License.
Review comment:
I'm not sure why it is happening but now I can see on the staging:
<img width="278" alt="image" src="https://user-images.githubusercontent.com/26118465/158984228-35669fdc-70f5-4dd1-817b-18913c7e81b3.png">
##########
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).
+1. Assign the issue to yourself. To get the permission to do so, email
+ the [dev@ mailing list](/community/contact-us)
Review comment:
```suggestion
the [dev@beam.apache.org mailing list](/community/contact-us)
```
##########
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)
Review comment:
```suggestion
group. Email the [dev@beam.apache.org](/community/contact-us)
```
##########
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.
Review comment:
```suggestion
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.
```
##########
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
Review comment:
```suggestion
1. Consider [subscribing to the dev@beam.apache.org](/community/contact-us/) mailing list, especially
```
##########
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).
+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).
Review comment:
```suggestion
[examples](https://s.apache.org/beam-design-docs)) and email it to the [dev@beam.apache.org mailing list](/community/contact-us).
```
##########
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:
```suggestion
Discussion about contributing code to Beam happens on the [dev@beam.apache.org mailing list](/community/contact-us/). Introduce yourself!
```
##########
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:
```suggestion
```
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -147,7 +203,7 @@ To install:
./local-env-setup.sh
Review comment:
change these lines (from 210 lines):
```
To install:
1. Execute:
...
```
to
```
To install, execute:
...
```
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -160,102 +216,91 @@ script which is part of the Beam repo:
./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.
+<br><br>
-### 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> git@github.com:<GitHub_user>/beam.git
- $ git fetch --all
- 1. Get or Update all the Go SDK dependencies
- $ go get -u ./...
-
-1. Check the environment was set up correctly.
- - **Option 1**: validate the Go, Java, and Python environments:
-
- **Important**: Make sure you have activated Python development.
+  We recommend putting it in your `$GOPATH` (`$HOME/go` by default on Unix systems).
+
+  Clone the repo, and update your branch as normal
+
+
+```
+$ git clone https://github.com/apache/beam.git
+$ cd beam
+$ git remote add <GitHub_user> git@github.com:<GitHub_user>/beam.git
+$ git fetch --all
+```
+
+  Get or Update all the Go SDK dependencies
+ ```
+$ go get -u ./...
+```
+<br>
+
+3. Check the environment was set up correctly.
+
+  **Option 1**: validate the Go, Java, and Python environments:
+
+  **Important**: Make sure you have activated Python development.
```
./gradlew :checkSetup
```
- - **Option 2**: Run independent checks:
- - For **Go development**:
- 1. Execute:
+
+
+  **Option 2**: Run independent checks:
+
+    For **Go development**:
```
-export GOLANG_PROTOBUF_REGISTRATION_CONFLICT=ignore
-./gradlew :sdks:go:examples:wordCount
+export GOLANG_PROTOBUF_REGISTRATION_CONFLICT=ignore./gradlew :sdks:go:examples:wordCount
```
- - For **Python development**:
- 1. Execute:
+    For **Python development**:
```
./gradlew :sdks:python:wordCount
```
- - For **Java development**:
- 1. Execute:
+    For **Java development**:
```
./gradlew :examples:java:wordCount
```
+<br>
-1. Familiarize yourself with gradle and the project structure. At the root of the git repository, run:
-
- $ ./gradlew projects
-
+4. Familiarize yourself with gradle and the project structure. At the root of the git repository, run:
Review comment:
```suggestion
4. Familiarize yourself with gradle and the project structure.
  At the root of the git repository, run:
```
##########
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).
+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).
+
+### Setup Your Environment
+
+#### Configuration Options
You have two options for configuring your development environment:
- Local:
- - Manually installing the prerequisites listed above.
- - Using the automated script for Linux and macOS.
-- Container: using a Docker image.
+ - Manually installing the [prerequisites](https://beam.apache.org/contribute/#prerequisites).
+ - Using the automated script for Linux and macOS.
+- Container: using a [Docker](https://www.docker.com/) image.
Review comment:
```suggestion
- Container-based: using a [Docker](https://www.docker.com/) image.
```
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -160,102 +216,91 @@ script which is part of the Beam repo:
./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.
+<br><br>
Review comment:
```suggestion
```
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -285,12 +335,15 @@ export GOLANG_PROTOBUF_REGISTRATION_CONFLICT=ignore
jobs](https://cwiki.apache.org/confluence/display/BEAM/Contribution+Testing+Guide#ContributionTestingGuide-Pre-commit). If a test fails and appears unrelated to your
change, you can cause tests to be re-run by adding a single line comment on your
PR
Review comment:
```suggestion
PR:
```
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -160,102 +216,91 @@ script which is part of the Beam repo:
./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.
+<br><br>
-### 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> git@github.com:<GitHub_user>/beam.git
- $ git fetch --all
- 1. Get or Update all the Go SDK dependencies
- $ go get -u ./...
-
-1. Check the environment was set up correctly.
- - **Option 1**: validate the Go, Java, and Python environments:
-
- **Important**: Make sure you have activated Python development.
+  We recommend putting it in your `$GOPATH` (`$HOME/go` by default on Unix systems).
+
+  Clone the repo, and update your branch as normal
+
+
+```
+$ git clone https://github.com/apache/beam.git
+$ cd beam
+$ git remote add <GitHub_user> git@github.com:<GitHub_user>/beam.git
+$ git fetch --all
+```
+
+  Get or Update all the Go SDK dependencies
+ ```
+$ go get -u ./...
+```
+<br>
+
+3. Check the environment was set up correctly.
+
+  **Option 1**: validate the Go, Java, and Python environments:
+
+  **Important**: Make sure you have activated Python development.
```
./gradlew :checkSetup
```
- - **Option 2**: Run independent checks:
- - For **Go development**:
- 1. Execute:
+
+
+  **Option 2**: Run independent checks:
+
+    For **Go development**:
```
-export GOLANG_PROTOBUF_REGISTRATION_CONFLICT=ignore
-./gradlew :sdks:go:examples:wordCount
+export GOLANG_PROTOBUF_REGISTRATION_CONFLICT=ignore./gradlew :sdks:go:examples:wordCount
```
- - For **Python development**:
- 1. Execute:
+    For **Python development**:
```
./gradlew :sdks:python:wordCount
```
- - For **Java development**:
- 1. Execute:
+    For **Java development**:
```
./gradlew :examples:java:wordCount
```
+<br>
-1. Familiarize yourself with gradle and the project structure. At the root of the git repository, run:
-
- $ ./gradlew projects
-
+4. Familiarize yourself with gradle and the project structure. At the root of the git repository, run:
+ ```
+$ ./gradlew projects
+ ```
Examine the available tasks in a project. For the default set of tasks, use:
Review comment:
```suggestion
  Examine the available tasks in a project. For the default set of tasks, use:
```
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -160,102 +216,91 @@ script which is part of the Beam repo:
./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.
+<br><br>
-### 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> git@github.com:<GitHub_user>/beam.git
- $ git fetch --all
- 1. Get or Update all the Go SDK dependencies
- $ go get -u ./...
-
-1. Check the environment was set up correctly.
- - **Option 1**: validate the Go, Java, and Python environments:
-
- **Important**: Make sure you have activated Python development.
+  We recommend putting it in your `$GOPATH` (`$HOME/go` by default on Unix systems).
+
+  Clone the repo, and update your branch as normal
+
+
+```
+$ git clone https://github.com/apache/beam.git
+$ cd beam
+$ git remote add <GitHub_user> git@github.com:<GitHub_user>/beam.git
+$ git fetch --all
+```
+
+  Get or Update all the Go SDK dependencies
+ ```
+$ go get -u ./...
+```
+<br>
+
+3. Check the environment was set up correctly.
+
+  **Option 1**: validate the Go, Java, and Python environments:
+
+  **Important**: Make sure you have activated Python development.
```
./gradlew :checkSetup
```
- - **Option 2**: Run independent checks:
- - For **Go development**:
- 1. Execute:
+
+
+  **Option 2**: Run independent checks:
+
+    For **Go development**:
```
-export GOLANG_PROTOBUF_REGISTRATION_CONFLICT=ignore
-./gradlew :sdks:go:examples:wordCount
+export GOLANG_PROTOBUF_REGISTRATION_CONFLICT=ignore./gradlew :sdks:go:examples:wordCount
```
- - For **Python development**:
- 1. Execute:
+    For **Python development**:
```
./gradlew :sdks:python:wordCount
```
- - For **Java development**:
- 1. Execute:
+    For **Java development**:
```
./gradlew :examples:java:wordCount
```
+<br>
-1. Familiarize yourself with gradle and the project structure. At the root of the git repository, run:
-
- $ ./gradlew projects
-
+4. Familiarize yourself with gradle and the project structure. At the root of the git repository, run:
+ ```
+$ ./gradlew projects
+ ```
Examine the available tasks in a project. For the default set of tasks, use:
-
- $ ./gradlew tasks
-
+ ```
+$ ./gradlew tasks
+ ```
For a given module, use:
-
- $ ./gradlew -p sdks/java/io/cassandra tasks
-
- For an exhaustive list of tasks, use:
-
- $ ./gradlew tasks --all
-
-1. Make sure you can build and run tests
+ ```
+$ ./gradlew -p sdks/java/io/cassandra tasks
+ ```
+ For an exhaustive list of tasks, use:
Review comment:
```suggestion
  For an exhaustive list of tasks, use:
```
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -160,102 +216,91 @@ script which is part of the Beam repo:
./start-build-env.sh
Review comment:
change these lines (from 211):
```
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:
```
to
```
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.
```
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -303,7 +356,7 @@ export GOLANG_PROTOBUF_REGISTRATION_CONFLICT=ignore
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.
-### Make the reviewer's job easier
+#### Make the reviewer's job easier
Review comment:
```suggestion
#### Make the Reviewer’s Job Easier
```
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -321,69 +374,38 @@ 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).
+### Troubleshooting
-- [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!
+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/).
-## Additional resources
+If you didn't find the information you were looking for in this guide, please
+[reach out to the Beam community](/community/contact-us).
-If you are contributing a `PTransform` to Beam, we have an extensive
-[PTransform Style Guide](/contribute/ptransform-style-guide).
+</div>
-If you are contributing a Runner to Beam, refer to the
-[Runner authoring guide](/contribute/runner-guide/)
+## 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/).
+## Other Resources
Review comment:
```suggestion
## Additional Resources
```
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -303,7 +356,7 @@ export GOLANG_PROTOBUF_REGISTRATION_CONFLICT=ignore
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
Review comment:
```suggestion
1. If you don't get any response in 3 business days, email the [dev@beam.apache.org mailing list](/community/contact-us) to ask for someone to look at your pull
```
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -321,69 +374,38 @@ 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).
+### Troubleshooting
-- [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!
+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/).
-## Additional resources
+If you didn't find the information you were looking for in this guide, please
+[reach out to the Beam community](/community/contact-us).
-If you are contributing a `PTransform` to Beam, we have an extensive
-[PTransform Style Guide](/contribute/ptransform-style-guide).
+</div>
-If you are contributing a Runner to Beam, refer to the
-[Runner authoring guide](/contribute/runner-guide/)
+## 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/).
+## Other Resources
+Please see Beam developers’ Wiki Contributor FAQ for more information.
+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).
+If you are contributing a Runner to Beam, refer to the [Runner authoring guide](https://beam.apache.org/contribute/runner-guide/).
Review [design documents](https://s.apache.org/beam-design-docs).
Review comment:
```suggestion
Review [design documents](https://s.apache.org/beam-design-docs).
```
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -321,69 +374,38 @@ 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).
+### Troubleshooting
-- [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!
+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/).
-## Additional resources
+If you didn't find the information you were looking for in this guide, please
+[reach out to the Beam community](/community/contact-us).
-If you are contributing a `PTransform` to Beam, we have an extensive
-[PTransform Style Guide](/contribute/ptransform-style-guide).
+</div>
-If you are contributing a Runner to Beam, refer to the
-[Runner authoring guide](/contribute/runner-guide/)
+## 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/).
+## Other Resources
+Please see Beam developers’ Wiki Contributor FAQ for more information.
+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).
+If you are contributing a Runner to Beam, refer to the [Runner authoring guide](https://beam.apache.org/contribute/runner-guide/).
Review [design documents](https://s.apache.org/beam-design-docs).
-
-A great way to contribute is to join an existing effort. For the most
-intensive efforts, check out the [roadmap](/roadmap/).
-
-You can also find a more exhaustive list on the [Beam developers' wiki](
-https://cwiki.apache.org/confluence/display/BEAM/Apache+Beam)
-
-## Troubleshooting
-
-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/).
-
-If you didn't find the information you were looking for in this guide, please
-[reach out to the Beam community](/community/contact-us).
+You can also find out more information on the [Beam developers’ Wiki](
Review comment:
```suggestion
You can also find out more information on the [Beam developers’ Wiki](
```
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -321,69 +374,38 @@ 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).
+### Troubleshooting
-- [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!
+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/).
-## Additional resources
+If you didn't find the information you were looking for in this guide, please
+[reach out to the Beam community](/community/contact-us).
-If you are contributing a `PTransform` to Beam, we have an extensive
-[PTransform Style Guide](/contribute/ptransform-style-guide).
+</div>
-If you are contributing a Runner to Beam, refer to the
-[Runner authoring guide](/contribute/runner-guide/)
+## 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/).
+## Other Resources
+Please see Beam developers’ Wiki Contributor FAQ for more information.
+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:
```suggestion
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).
```
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -321,69 +374,38 @@ 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).
+### Troubleshooting
-- [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!
+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/).
-## Additional resources
+If you didn't find the information you were looking for in this guide, please
+[reach out to the Beam community](/community/contact-us).
-If you are contributing a `PTransform` to Beam, we have an extensive
-[PTransform Style Guide](/contribute/ptransform-style-guide).
+</div>
-If you are contributing a Runner to Beam, refer to the
-[Runner authoring guide](/contribute/runner-guide/)
+## 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/).
+## Other Resources
+Please see Beam developers’ Wiki Contributor FAQ for more information.
+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).
+If you are contributing a Runner to Beam, refer to the [Runner authoring guide](https://beam.apache.org/contribute/runner-guide/).
Review comment:
```suggestion
If you are contributing a Runner to Beam, refer to the [Runner authoring guide](https://beam.apache.org/contribute/runner-guide/).
```
--
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: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] dariabezkorovaina commented on a change in pull request #17089: [BEAM-13992] [Website] update Contribute/Code Contribution Guide page
Posted by GitBox <gi...@apache.org>.
dariabezkorovaina commented on a change in pull request #17089:
URL: https://github.com/apache/beam/pull/17089#discussion_r833267326
##########
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
##########
@@ -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> git@github.com:<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
--
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: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] dariabezkorovaina commented on pull request #17089: [BEAM-13992] [Website] update Contribute/Code Contribution Guide page
Posted by GitBox <gi...@apache.org>.
dariabezkorovaina commented on pull request #17089:
URL: https://github.com/apache/beam/pull/17089#issuecomment-1076835095
@pcoet please take a look:)
--
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: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] pcoet commented on a change in pull request #17089: [BEAM-13992] [Website] update Contribute/Code Contribution Guide page
Posted by GitBox <gi...@apache.org>.
pcoet commented on a change in pull request #17089:
URL: https://github.com/apache/beam/pull/17089#discussion_r838667125
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -140,122 +193,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> git@github.com:<GitHub_user>/beam.git
- $ git fetch --all
- 1. Get or Update all the Go SDK dependencies
- $ go get -u ./...
-
-1. Check the environment was set up correctly.
- - **Option 1**: validate the Go, Java, and Python environments:
-
- **Important**: Make sure you have activated Python development.
+  We recommend putting it in your `$GOPATH` (`$HOME/go` by default on Unix systems).
Review comment:
There should be a way to get the nested lists to display correctly without the ` ` characters. You might need to re-indent the whole procedure, and also take some things out of code fences. For example, there's no reason that "- For **Python development**: " should be formatted like code. I know this is how the content currently looks, but it's in bad shape right now. Can you take a pass through and actually make the indents work? I can help, if needed... If there's literally no way to get the indents right using markdown lists, I'd wonder if we have an issue in the CSS. Because I've never had to use HTML character entities in Markdown before.
--
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: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] bullet03 commented on a change in pull request #17089: [BEAM-13992] [Website] update Contribute/Code Contribution Guide page
Posted by GitBox <gi...@apache.org>.
bullet03 commented on a change in pull request #17089:
URL: https://github.com/apache/beam/pull/17089#discussion_r838382248
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -50,53 +50,106 @@ There are lots of opportunities to contribute. You can for example:
Cloud Dataflow, etc)
- improve or add IO connectors
- add new transform libraries (statistics, ML, image processing, etc)
- - work on the core programming model (what is a Beam pipeline and how does it
- run?)
+ - work on the core programming model (read more about what a Beam pipeline is and how it runs here in [Documentation](https://beam.apache.org/documentation/basics/))
- improve the developer experience (for example, Windows guides)
- add answers to the [contribution FAQ](
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@beam.apache.org]( https://beam.apache.org/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 [dev@beam.apache.org](/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@beam.apache.org](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 [dev@beam.apache.org mailing list](https://beam.apache.org/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. 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.
Review comment:
changed
--
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: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] dariabezkorovaina commented on a change in pull request #17089: [BEAM-13992] [Website] update Contribute/Code Contribution Guide page
Posted by GitBox <gi...@apache.org>.
dariabezkorovaina commented on a change in pull request #17089:
URL: https://github.com/apache/beam/pull/17089#discussion_r833243807
##########
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 dev@beam.apache.org](/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.
Review comment:
Will need to change the link to 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: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] bullet03 commented on a change in pull request #17089: [BEAM-13992] [Website] update Contribute/Code Contribution Guide page
Posted by GitBox <gi...@apache.org>.
bullet03 commented on a change in pull request #17089:
URL: https://github.com/apache/beam/pull/17089#discussion_r833129836
##########
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.
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: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] bullet03 commented on a change in pull request #17089: [BEAM-13992] [Website] update Contribute/Code Contribution Guide page
Posted by GitBox <gi...@apache.org>.
bullet03 commented on a change in pull request #17089:
URL: https://github.com/apache/beam/pull/17089#discussion_r837374783
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -57,46 +57,100 @@ There are lots of opportunities to contribute. You can for example:
https://cwiki.apache.org/confluence/display/BEAM/Contributor+FAQ)
Review comment:
changed
--
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: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] pcoet commented on a change in pull request #17089: [BEAM-13992] [Website] update Contribute/Code Contribution Guide page
Posted by GitBox <gi...@apache.org>.
pcoet commented on a change in pull request #17089:
URL: https://github.com/apache/beam/pull/17089#discussion_r837758539
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -140,122 +193,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
Review comment:
LGTM
--
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: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] bullet03 commented on a change in pull request #17089: [BEAM-13992] [Website] update Contribute/Code Contribution Guide page
Posted by GitBox <gi...@apache.org>.
bullet03 commented on a change in pull request #17089:
URL: https://github.com/apache/beam/pull/17089#discussion_r838381997
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -50,53 +50,106 @@ There are lots of opportunities to contribute. You can for example:
Cloud Dataflow, etc)
- improve or add IO connectors
- add new transform libraries (statistics, ML, image processing, etc)
- - work on the core programming model (what is a Beam pipeline and how does it
- run?)
+ - work on the core programming model (read more about what a Beam pipeline is and how it runs here in [Documentation](https://beam.apache.org/documentation/basics/))
- improve the developer experience (for example, Windows guides)
- add answers to the [contribution FAQ](
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@beam.apache.org]( https://beam.apache.org/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.
Review comment:
changed
--
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: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] dariabezkorovaina commented on pull request #17089: [BEAM-13992] [Website] update Contribute/Code Contribution Guide page
Posted by GitBox <gi...@apache.org>.
dariabezkorovaina commented on pull request #17089:
URL: https://github.com/apache/beam/pull/17089#issuecomment-1085020925
@pcoet I think we implemented all your comments, thank you for the review! Can you please take another look?
--
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: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] dariabezkorovaina commented on a change in pull request #17089: [BEAM-13992] [Website] update Contribute/Code Contribution Guide page
Posted by GitBox <gi...@apache.org>.
dariabezkorovaina commented on a change in pull request #17089:
URL: https://github.com/apache/beam/pull/17089#discussion_r837080009
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -57,46 +57,100 @@ There are lots of opportunities to contribute. You can for example:
https://cwiki.apache.org/confluence/display/BEAM/Contributor+FAQ)
Review comment:
row 53 please change: (what is a Beam pipeline and how does it run?)
->
(read more about what a Beam pipeline is and how it runs [here in Documentation](https://beam.apache.org/documentation/basics/))
--
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: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] pcoet commented on a change in pull request #17089: [BEAM-13992] [Website] update Contribute/Code Contribution Guide page
Posted by GitBox <gi...@apache.org>.
pcoet commented on a change in pull request #17089:
URL: https://github.com/apache/beam/pull/17089#discussion_r837735529
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -140,122 +193,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
Review comment:
> It's better to use these command (like it is written now).
Why? Sorry if I'm missing something... I would think that you want to 1) Fork the repo; 2) clone the repo to your workspace. Cloning the repo onto your Go path is only necessary for Go development, right? It seems like we should call that out. Also, wouldn't you want to fork the repo before cloning it, no matter where you clone it? Again, please let me know if I'm missing something...
--
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: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] bullet03 commented on pull request #17089: [BEAM-13992] [Website] update Contribute/Code Contribution Guide page
Posted by GitBox <gi...@apache.org>.
bullet03 commented on pull request #17089:
URL: https://github.com/apache/beam/pull/17089#issuecomment-1067225214
R: @AydarZaynutdinov
--
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: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] AydarZaynutdinov commented on a change in pull request #17089: [BEAM-13992] [Website] update Contribute/Code Contribution Guide page
Posted by GitBox <gi...@apache.org>.
AydarZaynutdinov commented on a change in pull request #17089:
URL: https://github.com/apache/beam/pull/17089#discussion_r829858083
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -160,102 +216,91 @@ script which is part of the Beam repo:
./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.
+<br><br>
-### 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> git@github.com:<GitHub_user>/beam.git
- $ git fetch --all
- 1. Get or Update all the Go SDK dependencies
- $ go get -u ./...
-
-1. Check the environment was set up correctly.
- - **Option 1**: validate the Go, Java, and Python environments:
-
- **Important**: Make sure you have activated Python development.
+  We recommend putting it in your `$GOPATH` (`$HOME/go` by default on Unix systems).
Review comment:
```suggestion
  We recommend putting it in your `$GOPATH` (`$HOME/go` by default on Unix systems).
```
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -321,69 +374,38 @@ 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).
+### Troubleshooting
-- [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!
+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/).
-## Additional resources
+If you didn't find the information you were looking for in this guide, please
+[reach out to the Beam community](/community/contact-us).
-If you are contributing a `PTransform` to Beam, we have an extensive
-[PTransform Style Guide](/contribute/ptransform-style-guide).
+</div>
-If you are contributing a Runner to Beam, refer to the
-[Runner authoring guide](/contribute/runner-guide/)
+## 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).
Review comment:
```suggestion
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).
```
##########
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.
Review comment:
```suggestion
- A [GitHub](https://github.com/) account.
```
##########
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).
+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/).
Review comment:
```suggestion
[discuss it on the dev@beam.apache.org mailing list](/community/contact-us/).
```
##########
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).
Review comment:
```suggestion
[dev@beam.apache.org mailing list](/community/contact-us) (include your Wiki account user ID).
```
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -160,102 +216,91 @@ script which is part of the Beam repo:
./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.
+<br><br>
-### 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> git@github.com:<GitHub_user>/beam.git
- $ git fetch --all
- 1. Get or Update all the Go SDK dependencies
- $ go get -u ./...
-
-1. Check the environment was set up correctly.
- - **Option 1**: validate the Go, Java, and Python environments:
-
- **Important**: Make sure you have activated Python development.
+  We recommend putting it in your `$GOPATH` (`$HOME/go` by default on Unix systems).
+
+  Clone the repo, and update your branch as normal
+
+
+```
+$ git clone https://github.com/apache/beam.git
+$ cd beam
+$ git remote add <GitHub_user> git@github.com:<GitHub_user>/beam.git
+$ git fetch --all
+```
+
+  Get or Update all the Go SDK dependencies
+ ```
+$ go get -u ./...
+```
+<br>
+
+3. Check the environment was set up correctly.
+
+  **Option 1**: validate the Go, Java, and Python environments:
+
+  **Important**: Make sure you have activated Python development.
```
./gradlew :checkSetup
```
- - **Option 2**: Run independent checks:
- - For **Go development**:
- 1. Execute:
+
+
+  **Option 2**: Run independent checks:
+
+    For **Go development**:
```
-export GOLANG_PROTOBUF_REGISTRATION_CONFLICT=ignore
-./gradlew :sdks:go:examples:wordCount
+export GOLANG_PROTOBUF_REGISTRATION_CONFLICT=ignore./gradlew :sdks:go:examples:wordCount
```
- - For **Python development**:
- 1. Execute:
+    For **Python development**:
```
./gradlew :sdks:python:wordCount
```
- - For **Java development**:
- 1. Execute:
+    For **Java development**:
```
./gradlew :examples:java:wordCount
```
+<br>
-1. Familiarize yourself with gradle and the project structure. At the root of the git repository, run:
-
- $ ./gradlew projects
-
+4. Familiarize yourself with gradle and the project structure. At the root of the git repository, run:
+ ```
+$ ./gradlew projects
+ ```
Examine the available tasks in a project. For the default set of tasks, use:
-
- $ ./gradlew tasks
-
+ ```
+$ ./gradlew tasks
+ ```
For a given module, use:
-
- $ ./gradlew -p sdks/java/io/cassandra tasks
-
- For an exhaustive list of tasks, use:
-
- $ ./gradlew tasks --all
-
-1. Make sure you can build and run tests
+ ```
+$ ./gradlew -p sdks/java/io/cassandra tasks
+ ```
+ For an exhaustive list of tasks, use:
+ ```
+$ ./gradlew tasks --all
+ ```
+5. Make sure you can build and run tests
Review comment:
```suggestion
5. Make sure you can build and run tests.
```
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -160,102 +216,91 @@ script which is part of the Beam repo:
./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.
+<br><br>
-### 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> git@github.com:<GitHub_user>/beam.git
- $ git fetch --all
- 1. Get or Update all the Go SDK dependencies
- $ go get -u ./...
-
-1. Check the environment was set up correctly.
- - **Option 1**: validate the Go, Java, and Python environments:
-
- **Important**: Make sure you have activated Python development.
+  We recommend putting it in your `$GOPATH` (`$HOME/go` by default on Unix systems).
+
+  Clone the repo, and update your branch as normal
+
+
+```
+$ git clone https://github.com/apache/beam.git
+$ cd beam
+$ git remote add <GitHub_user> git@github.com:<GitHub_user>/beam.git
+$ git fetch --all
+```
+
+  Get or Update all the Go SDK dependencies
+ ```
+$ go get -u ./...
+```
+<br>
+
+3. Check the environment was set up correctly.
+
+  **Option 1**: validate the Go, Java, and Python environments:
+
+  **Important**: Make sure you have activated Python development.
```
./gradlew :checkSetup
```
- - **Option 2**: Run independent checks:
- - For **Go development**:
- 1. Execute:
+
+
+  **Option 2**: Run independent checks:
+
+    For **Go development**:
```
-export GOLANG_PROTOBUF_REGISTRATION_CONFLICT=ignore
-./gradlew :sdks:go:examples:wordCount
+export GOLANG_PROTOBUF_REGISTRATION_CONFLICT=ignore./gradlew :sdks:go:examples:wordCount
```
- - For **Python development**:
- 1. Execute:
+    For **Python development**:
```
./gradlew :sdks:python:wordCount
```
- - For **Java development**:
- 1. Execute:
+    For **Java development**:
```
./gradlew :examples:java:wordCount
```
+<br>
-1. Familiarize yourself with gradle and the project structure. At the root of the git repository, run:
-
- $ ./gradlew projects
-
+4. Familiarize yourself with gradle and the project structure. At the root of the git repository, run:
+ ```
+$ ./gradlew projects
+ ```
Examine the available tasks in a project. For the default set of tasks, use:
-
- $ ./gradlew tasks
-
+ ```
+$ ./gradlew tasks
+ ```
For a given module, use:
Review comment:
```suggestion
  For a given module, use:
```
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -321,69 +374,38 @@ 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
Review comment:
```suggestion
#### Stale Pull Requests
```
##########
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
Review comment:
```suggestion
### Connect with the Beam Community
```
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -35,7 +35,7 @@ limitations under the License.
Review comment:
I'm not sure why it is happening but now I can see on the staging:
<img width="278" alt="image" src="https://user-images.githubusercontent.com/26118465/158984228-35669fdc-70f5-4dd1-817b-18913c7e81b3.png">
##########
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).
+1. Assign the issue to yourself. To get the permission to do so, email
+ the [dev@ mailing list](/community/contact-us)
Review comment:
```suggestion
the [dev@beam.apache.org mailing list](/community/contact-us)
```
##########
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)
Review comment:
```suggestion
group. Email the [dev@beam.apache.org](/community/contact-us)
```
##########
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.
Review comment:
```suggestion
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.
```
##########
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
Review comment:
```suggestion
1. Consider [subscribing to the dev@beam.apache.org](/community/contact-us/) mailing list, especially
```
##########
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).
+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).
Review comment:
```suggestion
[examples](https://s.apache.org/beam-design-docs)) and email it to the [dev@beam.apache.org mailing list](/community/contact-us).
```
##########
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:
```suggestion
Discussion about contributing code to Beam happens on the [dev@beam.apache.org mailing list](/community/contact-us/). Introduce yourself!
```
##########
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:
```suggestion
```
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -147,7 +203,7 @@ To install:
./local-env-setup.sh
Review comment:
change these lines (from 210 lines):
```
To install:
1. Execute:
...
```
to
```
To install, execute:
...
```
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -160,102 +216,91 @@ script which is part of the Beam repo:
./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.
+<br><br>
-### 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> git@github.com:<GitHub_user>/beam.git
- $ git fetch --all
- 1. Get or Update all the Go SDK dependencies
- $ go get -u ./...
-
-1. Check the environment was set up correctly.
- - **Option 1**: validate the Go, Java, and Python environments:
-
- **Important**: Make sure you have activated Python development.
+  We recommend putting it in your `$GOPATH` (`$HOME/go` by default on Unix systems).
+
+  Clone the repo, and update your branch as normal
+
+
+```
+$ git clone https://github.com/apache/beam.git
+$ cd beam
+$ git remote add <GitHub_user> git@github.com:<GitHub_user>/beam.git
+$ git fetch --all
+```
+
+  Get or Update all the Go SDK dependencies
+ ```
+$ go get -u ./...
+```
+<br>
+
+3. Check the environment was set up correctly.
+
+  **Option 1**: validate the Go, Java, and Python environments:
+
+  **Important**: Make sure you have activated Python development.
```
./gradlew :checkSetup
```
- - **Option 2**: Run independent checks:
- - For **Go development**:
- 1. Execute:
+
+
+  **Option 2**: Run independent checks:
+
+    For **Go development**:
```
-export GOLANG_PROTOBUF_REGISTRATION_CONFLICT=ignore
-./gradlew :sdks:go:examples:wordCount
+export GOLANG_PROTOBUF_REGISTRATION_CONFLICT=ignore./gradlew :sdks:go:examples:wordCount
```
- - For **Python development**:
- 1. Execute:
+    For **Python development**:
```
./gradlew :sdks:python:wordCount
```
- - For **Java development**:
- 1. Execute:
+    For **Java development**:
```
./gradlew :examples:java:wordCount
```
+<br>
-1. Familiarize yourself with gradle and the project structure. At the root of the git repository, run:
-
- $ ./gradlew projects
-
+4. Familiarize yourself with gradle and the project structure. At the root of the git repository, run:
Review comment:
```suggestion
4. Familiarize yourself with gradle and the project structure.
  At the root of the git repository, run:
```
##########
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).
+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).
+
+### Setup Your Environment
+
+#### Configuration Options
You have two options for configuring your development environment:
- Local:
- - Manually installing the prerequisites listed above.
- - Using the automated script for Linux and macOS.
-- Container: using a Docker image.
+ - Manually installing the [prerequisites](https://beam.apache.org/contribute/#prerequisites).
+ - Using the automated script for Linux and macOS.
+- Container: using a [Docker](https://www.docker.com/) image.
Review comment:
```suggestion
- Container-based: using a [Docker](https://www.docker.com/) image.
```
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -160,102 +216,91 @@ script which is part of the Beam repo:
./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.
+<br><br>
Review comment:
```suggestion
```
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -285,12 +335,15 @@ export GOLANG_PROTOBUF_REGISTRATION_CONFLICT=ignore
jobs](https://cwiki.apache.org/confluence/display/BEAM/Contribution+Testing+Guide#ContributionTestingGuide-Pre-commit). If a test fails and appears unrelated to your
change, you can cause tests to be re-run by adding a single line comment on your
PR
Review comment:
```suggestion
PR:
```
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -160,102 +216,91 @@ script which is part of the Beam repo:
./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.
+<br><br>
-### 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> git@github.com:<GitHub_user>/beam.git
- $ git fetch --all
- 1. Get or Update all the Go SDK dependencies
- $ go get -u ./...
-
-1. Check the environment was set up correctly.
- - **Option 1**: validate the Go, Java, and Python environments:
-
- **Important**: Make sure you have activated Python development.
+  We recommend putting it in your `$GOPATH` (`$HOME/go` by default on Unix systems).
+
+  Clone the repo, and update your branch as normal
+
+
+```
+$ git clone https://github.com/apache/beam.git
+$ cd beam
+$ git remote add <GitHub_user> git@github.com:<GitHub_user>/beam.git
+$ git fetch --all
+```
+
+  Get or Update all the Go SDK dependencies
+ ```
+$ go get -u ./...
+```
+<br>
+
+3. Check the environment was set up correctly.
+
+  **Option 1**: validate the Go, Java, and Python environments:
+
+  **Important**: Make sure you have activated Python development.
```
./gradlew :checkSetup
```
- - **Option 2**: Run independent checks:
- - For **Go development**:
- 1. Execute:
+
+
+  **Option 2**: Run independent checks:
+
+    For **Go development**:
```
-export GOLANG_PROTOBUF_REGISTRATION_CONFLICT=ignore
-./gradlew :sdks:go:examples:wordCount
+export GOLANG_PROTOBUF_REGISTRATION_CONFLICT=ignore./gradlew :sdks:go:examples:wordCount
```
- - For **Python development**:
- 1. Execute:
+    For **Python development**:
```
./gradlew :sdks:python:wordCount
```
- - For **Java development**:
- 1. Execute:
+    For **Java development**:
```
./gradlew :examples:java:wordCount
```
+<br>
-1. Familiarize yourself with gradle and the project structure. At the root of the git repository, run:
-
- $ ./gradlew projects
-
+4. Familiarize yourself with gradle and the project structure. At the root of the git repository, run:
+ ```
+$ ./gradlew projects
+ ```
Examine the available tasks in a project. For the default set of tasks, use:
Review comment:
```suggestion
  Examine the available tasks in a project. For the default set of tasks, use:
```
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -160,102 +216,91 @@ script which is part of the Beam repo:
./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.
+<br><br>
-### 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> git@github.com:<GitHub_user>/beam.git
- $ git fetch --all
- 1. Get or Update all the Go SDK dependencies
- $ go get -u ./...
-
-1. Check the environment was set up correctly.
- - **Option 1**: validate the Go, Java, and Python environments:
-
- **Important**: Make sure you have activated Python development.
+  We recommend putting it in your `$GOPATH` (`$HOME/go` by default on Unix systems).
+
+  Clone the repo, and update your branch as normal
+
+
+```
+$ git clone https://github.com/apache/beam.git
+$ cd beam
+$ git remote add <GitHub_user> git@github.com:<GitHub_user>/beam.git
+$ git fetch --all
+```
+
+  Get or Update all the Go SDK dependencies
+ ```
+$ go get -u ./...
+```
+<br>
+
+3. Check the environment was set up correctly.
+
+  **Option 1**: validate the Go, Java, and Python environments:
+
+  **Important**: Make sure you have activated Python development.
```
./gradlew :checkSetup
```
- - **Option 2**: Run independent checks:
- - For **Go development**:
- 1. Execute:
+
+
+  **Option 2**: Run independent checks:
+
+    For **Go development**:
```
-export GOLANG_PROTOBUF_REGISTRATION_CONFLICT=ignore
-./gradlew :sdks:go:examples:wordCount
+export GOLANG_PROTOBUF_REGISTRATION_CONFLICT=ignore./gradlew :sdks:go:examples:wordCount
```
- - For **Python development**:
- 1. Execute:
+    For **Python development**:
```
./gradlew :sdks:python:wordCount
```
- - For **Java development**:
- 1. Execute:
+    For **Java development**:
```
./gradlew :examples:java:wordCount
```
+<br>
-1. Familiarize yourself with gradle and the project structure. At the root of the git repository, run:
-
- $ ./gradlew projects
-
+4. Familiarize yourself with gradle and the project structure. At the root of the git repository, run:
+ ```
+$ ./gradlew projects
+ ```
Examine the available tasks in a project. For the default set of tasks, use:
-
- $ ./gradlew tasks
-
+ ```
+$ ./gradlew tasks
+ ```
For a given module, use:
-
- $ ./gradlew -p sdks/java/io/cassandra tasks
-
- For an exhaustive list of tasks, use:
-
- $ ./gradlew tasks --all
-
-1. Make sure you can build and run tests
+ ```
+$ ./gradlew -p sdks/java/io/cassandra tasks
+ ```
+ For an exhaustive list of tasks, use:
Review comment:
```suggestion
  For an exhaustive list of tasks, use:
```
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -160,102 +216,91 @@ script which is part of the Beam repo:
./start-build-env.sh
Review comment:
change these lines (from 211):
```
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:
```
to
```
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.
```
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -303,7 +356,7 @@ export GOLANG_PROTOBUF_REGISTRATION_CONFLICT=ignore
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.
-### Make the reviewer's job easier
+#### Make the reviewer's job easier
Review comment:
```suggestion
#### Make the Reviewer’s Job Easier
```
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -321,69 +374,38 @@ 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).
+### Troubleshooting
-- [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!
+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/).
-## Additional resources
+If you didn't find the information you were looking for in this guide, please
+[reach out to the Beam community](/community/contact-us).
-If you are contributing a `PTransform` to Beam, we have an extensive
-[PTransform Style Guide](/contribute/ptransform-style-guide).
+</div>
-If you are contributing a Runner to Beam, refer to the
-[Runner authoring guide](/contribute/runner-guide/)
+## 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/).
+## Other Resources
Review comment:
```suggestion
## Additional Resources
```
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -303,7 +356,7 @@ export GOLANG_PROTOBUF_REGISTRATION_CONFLICT=ignore
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
Review comment:
```suggestion
1. If you don't get any response in 3 business days, email the [dev@beam.apache.org mailing list](/community/contact-us) to ask for someone to look at your pull
```
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -321,69 +374,38 @@ 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).
+### Troubleshooting
-- [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!
+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/).
-## Additional resources
+If you didn't find the information you were looking for in this guide, please
+[reach out to the Beam community](/community/contact-us).
-If you are contributing a `PTransform` to Beam, we have an extensive
-[PTransform Style Guide](/contribute/ptransform-style-guide).
+</div>
-If you are contributing a Runner to Beam, refer to the
-[Runner authoring guide](/contribute/runner-guide/)
+## 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/).
+## Other Resources
+Please see Beam developers’ Wiki Contributor FAQ for more information.
+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).
+If you are contributing a Runner to Beam, refer to the [Runner authoring guide](https://beam.apache.org/contribute/runner-guide/).
Review [design documents](https://s.apache.org/beam-design-docs).
Review comment:
```suggestion
Review [design documents](https://s.apache.org/beam-design-docs).
```
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -321,69 +374,38 @@ 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).
+### Troubleshooting
-- [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!
+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/).
-## Additional resources
+If you didn't find the information you were looking for in this guide, please
+[reach out to the Beam community](/community/contact-us).
-If you are contributing a `PTransform` to Beam, we have an extensive
-[PTransform Style Guide](/contribute/ptransform-style-guide).
+</div>
-If you are contributing a Runner to Beam, refer to the
-[Runner authoring guide](/contribute/runner-guide/)
+## 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/).
+## Other Resources
+Please see Beam developers’ Wiki Contributor FAQ for more information.
+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).
+If you are contributing a Runner to Beam, refer to the [Runner authoring guide](https://beam.apache.org/contribute/runner-guide/).
Review [design documents](https://s.apache.org/beam-design-docs).
-
-A great way to contribute is to join an existing effort. For the most
-intensive efforts, check out the [roadmap](/roadmap/).
-
-You can also find a more exhaustive list on the [Beam developers' wiki](
-https://cwiki.apache.org/confluence/display/BEAM/Apache+Beam)
-
-## Troubleshooting
-
-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/).
-
-If you didn't find the information you were looking for in this guide, please
-[reach out to the Beam community](/community/contact-us).
+You can also find out more information on the [Beam developers’ Wiki](
Review comment:
```suggestion
You can also find out more information on the [Beam developers’ Wiki](
```
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -321,69 +374,38 @@ 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).
+### Troubleshooting
-- [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!
+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/).
-## Additional resources
+If you didn't find the information you were looking for in this guide, please
+[reach out to the Beam community](/community/contact-us).
-If you are contributing a `PTransform` to Beam, we have an extensive
-[PTransform Style Guide](/contribute/ptransform-style-guide).
+</div>
-If you are contributing a Runner to Beam, refer to the
-[Runner authoring guide](/contribute/runner-guide/)
+## 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/).
+## Other Resources
+Please see Beam developers’ Wiki Contributor FAQ for more information.
+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:
```suggestion
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).
```
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -321,69 +374,38 @@ 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).
+### Troubleshooting
-- [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!
+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/).
-## Additional resources
+If you didn't find the information you were looking for in this guide, please
+[reach out to the Beam community](/community/contact-us).
-If you are contributing a `PTransform` to Beam, we have an extensive
-[PTransform Style Guide](/contribute/ptransform-style-guide).
+</div>
-If you are contributing a Runner to Beam, refer to the
-[Runner authoring guide](/contribute/runner-guide/)
+## 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/).
+## Other Resources
+Please see Beam developers’ Wiki Contributor FAQ for more information.
+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).
+If you are contributing a Runner to Beam, refer to the [Runner authoring guide](https://beam.apache.org/contribute/runner-guide/).
Review comment:
```suggestion
If you are contributing a Runner to Beam, refer to the [Runner authoring guide](https://beam.apache.org/contribute/runner-guide/).
```
--
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: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] bullet03 commented on a change in pull request #17089: [BEAM-13992] [Website] update Contribute/Code Contribution Guide page
Posted by GitBox <gi...@apache.org>.
bullet03 commented on a change in pull request #17089:
URL: https://github.com/apache/beam/pull/17089#discussion_r833129649
##########
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:
already 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: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] dariabezkorovaina commented on a change in pull request #17089: [BEAM-13992] [Website] update Contribute/Code Contribution Guide page
Posted by GitBox <gi...@apache.org>.
dariabezkorovaina commented on a change in pull request #17089:
URL: https://github.com/apache/beam/pull/17089#discussion_r833250417
##########
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 dev@beam.apache.org](/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 [dev@beam.apache.org](/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@beam.apache.org](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 [dev@beam.apache.org 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!
Review comment:
slack-> Slack
change link to 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: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] dariabezkorovaina commented on a change in pull request #17089: [BEAM-13992] [Website] update Contribute/Code Contribution Guide page
Posted by GitBox <gi...@apache.org>.
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 dev@beam.apache.org](/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 [dev@beam.apache.org](/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@beam.apache.org](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 [dev@beam.apache.org 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 dev@beam.apache.org](/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 [dev@beam.apache.org](/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@beam.apache.org](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 [dev@beam.apache.org 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 dev@beam.apache.org](/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 [dev@beam.apache.org](/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@beam.apache.org](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 [dev@beam.apache.org 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 [dev@beam.apache.org 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 dev@beam.apache.org 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 [dev@beam.apache.org 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 dev@beam.apache.org](/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 [dev@beam.apache.org](/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@beam.apache.org](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 [dev@beam.apache.org 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> git@github.com:<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 [dev@beam.apache.org 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 dev@beam.apache.org](/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 [dev@beam.apache.org](/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@beam.apache.org](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 [dev@beam.apache.org 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 dev@beam.apache.org](/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 [dev@beam.apache.org](/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@beam.apache.org](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 [dev@beam.apache.org 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: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] dariabezkorovaina commented on a change in pull request #17089: [BEAM-13992] [Website] update Contribute/Code Contribution Guide page
Posted by GitBox <gi...@apache.org>.
dariabezkorovaina commented on a change in pull request #17089:
URL: https://github.com/apache/beam/pull/17089#discussion_r833304655
##########
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 dev@beam.apache.org](/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 [dev@beam.apache.org](/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@beam.apache.org](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 [dev@beam.apache.org 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).
Review comment:
Add dots after bullet points for consistency
--
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: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] bullet03 commented on a change in pull request #17089: [BEAM-13992] [Website] update Contribute/Code Contribution Guide page
Posted by GitBox <gi...@apache.org>.
bullet03 commented on a change in pull request #17089:
URL: https://github.com/apache/beam/pull/17089#discussion_r833367350
##########
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> git@github.com:<GitHub_user>/beam.git
- $ git fetch --all
- 1. Get or Update all the Go SDK dependencies
- $ go get -u ./...
-
-1. Check the environment was set up correctly.
- - **Option 1**: validate the Go, Java, and Python environments:
-
- **Important**: Make sure you have activated Python development.
+  We recommend putting it in your `$GOPATH` (`$HOME/go` by default on Unix systems).
+
+  Clone the repo, and update your branch as normal
+
+
+```
+$ git clone https://github.com/apache/beam.git
+$ cd beam
+$ git remote add <GitHub_user> git@github.com:<GitHub_user>/beam.git
+$ git fetch --all
+```
+
+  Get or Update all the Go SDK dependencies
Review comment:
done
##########
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 dev@beam.apache.org](/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 [dev@beam.apache.org](/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@beam.apache.org](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 [dev@beam.apache.org 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).
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: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] bullet03 commented on a change in pull request #17089: [BEAM-13992] [Website] update Contribute/Code Contribution Guide page
Posted by GitBox <gi...@apache.org>.
bullet03 commented on a change in pull request #17089:
URL: https://github.com/apache/beam/pull/17089#discussion_r833351896
##########
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 dev@beam.apache.org](/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 [dev@beam.apache.org](/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@beam.apache.org](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 [dev@beam.apache.org 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!
Review comment:
done
##########
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 dev@beam.apache.org](/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 [dev@beam.apache.org](/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@beam.apache.org](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 [dev@beam.apache.org 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:
done
##########
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 dev@beam.apache.org](/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 [dev@beam.apache.org](/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@beam.apache.org](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 [dev@beam.apache.org 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: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] bullet03 commented on a change in pull request #17089: [BEAM-13992] [Website] update Contribute/Code Contribution Guide page
Posted by GitBox <gi...@apache.org>.
bullet03 commented on a change in pull request #17089:
URL: https://github.com/apache/beam/pull/17089#discussion_r833142832
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -303,7 +356,7 @@ export GOLANG_PROTOBUF_REGISTRATION_CONFLICT=ignore
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.
-### Make the reviewer's job easier
+#### Make the reviewer's job easier
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: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org