Repository: incubator-beam-site Updated Branches: refs/heads/asf-site dc8d3fbfa -> e0ae01c5f
Reordered IDE section after code checkout and tweaked heading levels. Project: http://git-wip-us.apache.org/repos/asf/incubator-beam-site/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-beam-site/commit/0f11cc51 Tree: http://git-wip-us.apache.org/repos/asf/incubator-beam-site/tree/0f11cc51 Diff: http://git-wip-us.apache.org/repos/asf/incubator-beam-site/diff/0f11cc51 Branch: refs/heads/asf-site Commit: 0f11cc51bba2165caac4d1422c0e26485ac5f79f Parents: ebb8322 Author: Frances Perry <[email protected]> Authored: Tue Oct 25 21:08:59 2016 -0700 Committer: Frances Perry <[email protected]> Committed: Tue Oct 25 21:54:31 2016 -0700 ---------------------------------------------------------------------- contribute/contribution-guide.md | 82 +++++++++++++++++------------------ 1 file changed, 41 insertions(+), 41 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-beam-site/blob/0f11cc51/contribute/contribution-guide.md ---------------------------------------------------------------------- diff --git a/contribute/contribution-guide.md b/contribute/contribution-guide.md index 2645cb3..e0dd507 100644 --- a/contribute/contribution-guide.md +++ b/contribute/contribution-guide.md @@ -60,47 +60,6 @@ To contribute code to Apache Beam, youâll have to do a few administrative step ### One-time Setup -#### Intellij - -#### Eclipse - -Use a recent eclipse version that includes m2e. Currently we recommend Eclipse Neon. -Start eclipse with a fresh workspace in a separate directory from your checkout. - -##### Install the m2e apt support - -Beam uses apt annotation processing to provide auto generated code. One example is the usage of [google auto value](https://github.com/google/auto/tree/master/value). By default m2e does not support this and you will see compile errors. - -Install m2e-apt - - Help - -> Eclipse Marketplace - -> Search for "m2 apt" - -> Install m2e-apt 1.2 or higher - - -Activate the apt processing - - Window - -> Preferences - -> Maven - -> Annotation processing - -> Switch to Experimental: Delegate annoation processing ... - -> Ok - -##### Import the beam projects - - File - -> Import... - -> Existing Maven Projects - -> Browse to the directory you cloned into and select incubator-beam - -> make sure all beam projects are selected - -> Finalize - -You now should have all the beam projects imported into eclipse and should see no compile errors. - - - #### [Potentially] Submit Contributor License Agreement Apache Software Foundation (ASF) desires that all contributors of ideas, code, or documentation to the Apache projects complete, sign, and submit an [Individual Contributor License Agreement](https://www.apache.org/licenses/icla.txt) (ICLA). The purpose of this agreement is to clearly define the terms under which intellectual property has been contributed to the ASF and thereby allow us to defend the project should there be a legal dispute regarding the software at some future time. @@ -132,6 +91,47 @@ Add your forked repository as an additional Git remote, where youâll push your You are now ready to start developing! +#### [Optional] IDE Setup + +Depending on your preferred development environment, you may need to prepare it to develop Beam code. + +##### Intellij + +_If you are an Intellij user, please contribute instructions! See [BEAM-835](https://issues.apache.org/jira/browse/BEAM-835)._ + +##### Eclipse + +Use a recent eclipse version that includes m2e. Currently we recommend Eclipse Neon. +Start eclipse with a fresh workspace in a separate directory from your checkout. + +1. Install m2e-apt: Beam uses apt annotation processing to provide auto generated code. One example is the usage of [google auto value](https://github.com/google/auto/tree/master/value). By default m2e does not support this and you will see compile errors. + + Help + -> Eclipse Marketplace + -> Search for "m2 apt" + -> Install m2e-apt 1.2 or higher + +1. Activate the apt processing + + Window + -> Preferences + -> Maven + -> Annotation processing + -> Switch to Experimental: Delegate annotation processing ... + -> Ok + +1. Import the beam projects + + File + -> Import... + -> Existing Maven Projects + -> Browse to the directory you cloned into and select incubator-beam + -> make sure all beam projects are selected + -> Finalize + +You now should have all the beam projects imported into eclipse and should see no compile errors. + + ### Create a branch in your fork Youâll work on your contribution in a branch in your own (forked) repository. Create a local branch, initialized with the state of the branch you expect your changes to be merged into. Keep in mind that we use several branches, including `master`, feature-specific, and release-specific branches. If you are unsure, initialize with the state of the `master` branch.
