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/29 16:57:04 UTC
[GitHub] [beam] pcoet commented on a change in pull request #17089: [BEAM-13992] [Website] update Contribute/Code Contribution Guide page
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