Jakub-Sadowski commented on a change in pull request #13565:
URL: https://github.com/apache/beam/pull/13565#discussion_r559200531
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -83,217 +76,136 @@ sudo apt-get install \
docker-ce
```
-On some systems (like Ubuntu 20.04) these need to be installed also
-```
-pip3 install grpcio-tools mypy-protobuf
-```
+</br>
You also need to [install Go](https://golang.org/doc/install).
+</br>
+
Once Go is installed, install goavro:
+</br>
+
```
$ export GOPATH=`pwd`/sdks/go/examples/.gogradle/project_gopath
$ go get github.com/linkedin/goavro
```
-gLinux users should configure their machines for sudoless Docker.
-
-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:
-```
-./start-build-env.sh
-```
-
-### Connect With the Beam community
-
-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).
-
-### 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).
-
-### Development Setup
-
-1. If you need help with git forking, cloning, branching, committing, pull
requests, and squashing commits, see
- [Git workflow
tips](https://cwiki.apache.org/confluence/display/BEAM/Git+Tips)
-1. 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
-
- 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
-
- Run the entire set of tests with:
+</br>
- $ ./gradlew check
+Linux users should configure their machines for sudoless Docker.
- You can limit testing to a particular module. Gradle will build just the
necessary things to run those tests. For example:
+</div>
- $ ./gradlew -p sdks/go check
- $ ./gradlew -p sdks/java/io/cassandra check
- $ ./gradlew -p runners/flink check
+<div class="arrow-lists-mobile">
-1. Now you may want to set up your preferred IDE and other aspects of your
development
- environment. See the Developers' wiki for tips, guides, and FAQs on:
- -
[IntelliJ](https://cwiki.apache.org/confluence/display/BEAM/Using+IntelliJ+IDE)
- - [Java](https://cwiki.apache.org/confluence/display/BEAM/Java+Tips)
- - [Python](https://cwiki.apache.org/confluence/display/BEAM/Python+Tips)
- - [Go](https://cwiki.apache.org/confluence/display/BEAM/Go+Tips)
- - [Website](https://cwiki.apache.org/confluence/display/BEAM/Website+Tips)
- - [Gradle](https://cwiki.apache.org/confluence/display/BEAM/Gradle+Tips)
- - [Jenkins](https://cwiki.apache.org/confluence/display/BEAM/Jenkins+Tips)
- - [FAQ](https://cwiki.apache.org/confluence/display/BEAM/Contributor+FAQ)
+ <a class="arrow-list-header" data-toggle="collapse" href="#collapseOverview"
role="button" aria-expanded="false" aria-controls="collapseOverview">
+ {{< figure src="/images/arrow-icon_list.svg">}}
-### Make your change
+Overview
-1. Make your code change. Every source file needs to include the Apache
license header. Every new dependency needs to
- have an open source license
[compatible](https://www.apache.org/legal/resolved.html#criteria) with Apache.
+ </a>
-1. Add unit tests for your change.
+<div class="collapse" id="collapseOverview">
-1. Use descriptive commit messages that make it easy to identify changes and
provide a clear history.
+There are lots of opportunities to contribute. You can for example:
-1. When your change is ready to be reviewed and merged, create a pull request.
+- ask or answer questions on [[email protected]](/community/contact-us/) or
+ [stackoverflow](https://stackoverflow.com/questions/tagged/apache-beam)
+- review proposed design ideas on
[[email protected]](/community/contact-us/)
+- file [bug reports](https://issues.apache.org/jira/projects/BEAM/issues)
+- review [changes](https://github.com/apache/beam/pulls)
+- work on the core programming model (what is a Beam pipeline and how does it
+ run?)
+- improve the developer experience (for example, Windows guides)
+- organize local meetups of users or contributors to Apache Beam
-1. Format commit messages and the pull request title like `[BEAM-XXX] Fixes
bug in ApproximateQuantiles`,
- where you replace BEAM-XXX with the appropriate JIRA issue.
- This will automatically link the pull request to the issue.
+...and many more. Most importantly, if you have an idea of how to contribute,
then do it!
-1. The pull request and any changes pushed to it will trigger [pre-commit
-
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
+</div>
- retest this please
+<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">}}
- Pull request template has a link to a [catalog of trigger
phrases](https://github.com/apache/beam/blob/master/.test-infra/jenkins/README.md)
- that start various post-commit tests suites. Use these sparingly because
post-commit tests consume shared development resources.
+Contributing code
-1. Pull requests can only be merged by a
- [Beam committer](https://home.apache.org/phonebook.html?pmc=beam).
- To find a committer for your area, either:
- - look in the OWNERS file of the directory where you changed files, or
- - look for similar code merges, or
- - ask on [[email protected]](/community/contact-us/)
+ </a>
- Use `R: @username` in the pull request to notify a reviewer.
+<div class="collapse" id="collapseContributing">
-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
-
-1. Provide context for your changes in the associated JIRA issue and/or PR
description.
-
-1. Avoid huge mega-changes.
-
-1. Review feedback typically leads to follow-up changes. It is easier to
review follow-up changes when they are added as additional "fixup" commits to
the
- existing PR/branch. This allows reviewer(s) to track the incremental
progress and focus on new changes,
- and keeps comment threads attached to the code.
- Please refrain from squashing new commits into reviewed commits before
review is completed.
- Because squashing reviewed and unreviewed commits often makes it harder to
- see the the difference between the review iterations, reviewers may ask you
to unsquash new changes.
-
-1. After review is complete and the PR is accepted, fixup commits should be
squashed (see [Git workflow
tips](https://cwiki.apache.org/confluence/display/BEAM/Git+Tips)).
- Beam committers [can
squash](https://beam.apache.org/contribute/committer-guide/#merging-it)
- 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
commmit history.
-
-## When will my change show up in an Apache Beam release?
-
-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
+Below is a tutorial for contributing code to Beam, covering our tools and
typical process in
+detail.
-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.
+- a GitHub account
+- a Linux, macOS, or Microsoft Windows development environment with Java JDK 8
installed
+- [Docker](https://www.docker.com/) installed for some tasks including
building worker containers and testing this website
+ changes locally
+- [Go](https://golang.org) 1.12 or later installed for Go SDK development
+- Python 3.6, 3.7, and 3.8. Yes, you need all four versions installed.
-## Accounts and Permissions
+ pip, setuptools, virtualenv, and tox installed for Python development
-- [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.
+- for large contributions, a signed [Individual Contributor License
+ Agreement](https://www.apache.org/licenses/icla.pdf) (ICLA) to the Apache
+ Software Foundation (ASF).
-- [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).
+</div>
-- Pull requests can only be merged by a
- [Beam committer](https://home.apache.org/phonebook.html?pmc=beam).
+</br>
-- [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.
+```
+sudo apt-get install \
+ openjdk-8-jdk \
+ python-setuptools \
+ python-pip \
+ virtualenv \
+ tox \
+ docker-ce
+```
-## Communication
+</br>
-All communication is expected to align with the [Code of
Conduct](https://www.apache.org/foundation/policies/conduct).
+You also need to [install Go](https://golang.org/doc/install).
-Discussion about contributing code to Beam happens on the [dev@ mailing
list](/community/contact-us/). Introduce yourself!
+</br>
-Questions can be asked on the [#beam channel of the ASF
slack](/community/contact-us/). Introduce yourself!
+Once Go is installed, install goavro:
-## Additional resources
+</br>
-If you are contributing a `PTransform` to Beam, we have an extensive
-[PTransform Style Guide](/contribute/ptransform-style-guide).
+```
+$ export GOPATH=`pwd`/sdks/go/examples/.gogradle/project_gopath
+$ go get github.com/linkedin/goavro
+```
-If you are contributing a Runner to Beam, refer to the
-[Runner authoring guide](/contribute/runner-guide/)
+</br>
-Review [design documents](https://s.apache.org/beam-design-docs).
+Linux users should configure their machines for sudoless Docker.
-A great way to contribute is to join an existing effort. For the most
-intensive efforts, check out the [roadmap](/roadmap/).
+</div>
Review comment:
Yes, unfortunately mobile version is a bit different so I had discern
and duplicate some informations
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
[email protected]
