[
https://issues.apache.org/jira/browse/BEAM-13992?focusedWorklogId=746637&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-746637
]
ASF GitHub Bot logged work on BEAM-13992:
-----------------------------------------
Author: ASF GitHub Bot
Created on: 23/Mar/22 16:05
Start Date: 23/Mar/22 16:05
Worklog Time Spent: 10m
Work Description: 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>
[email protected]:<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: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
Issue Time Tracking
-------------------
Worklog Id: (was: 746637)
Time Spent: 5h 50m (was: 5h 40m)
> [Website] Update Contribute/Code Contribution Guide page
> --------------------------------------------------------
>
> Key: BEAM-13992
> URL: https://issues.apache.org/jira/browse/BEAM-13992
> Project: Beam
> Issue Type: Improvement
> Components: website
> Reporter: Aydar Zaynutdinov
> Assignee: Bulat Safiullin
> Priority: P3
> Labels: website, website-update-sprint-2
> Time Spent: 5h 50m
> Remaining Estimate: 0h
>
> Need to update Contribute/Code Contribution Guide page according to TDD:
> # _Overview_
> # _Get Started:_
> ## _Connect with the Beam Community_
> ## _Accounts and Permissions_
> ## _Communication_
> # _Before You Begin:_
> ## _Prerequisites_
> ## _Share Your Intent_
> ## _Setup Your Environment:_
> ### _Configuration Options:_
> #### _Local: Debian-based Distribution_
> #### _Container: Docker-based_
> ### _Development Setup_
> # _Contribute Code:_
> ## _Create a Pull Request_
> ## _Review Process and Releases_
> ## Troubleshooting
> # _Find Efforts to Contribute to_
> # _Additional Resources_
> _Adding contributing guide feedback link
> [https://lists.apache.org/thread/tpy22xmrrdyqpc88l7hlcqp5m59n1v8h|https://www.google.com/url?q=https://lists.apache.org/thread/tpy22xmrrdyqpc88l7hlcqp5m59n1v8h&sa=D&source=docs&ust=1647372754175705&usg=AOvVaw2hJOPVm5hWsKs0hW0lWDTg]_
--
This message was sent by Atlassian Jira
(v8.20.1#820001)
