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: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
