You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@beam.apache.org by ke...@apache.org on 2016/10/31 03:46:11 UTC
[1/2] incubator-beam-site git commit: Add IntelliJ Checkstyle
documentation
Repository: incubator-beam-site
Updated Branches:
refs/heads/asf-site 6f087916f -> c60d96902
Add IntelliJ Checkstyle documentation
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/db18665a
Tree: http://git-wip-us.apache.org/repos/asf/incubator-beam-site/tree/db18665a
Diff: http://git-wip-us.apache.org/repos/asf/incubator-beam-site/diff/db18665a
Branch: refs/heads/asf-site
Commit: db18665a9bfbb3ca2e492c9afb9f8519c9a61596
Parents: 6f08791
Author: Scott Wegner <sw...@google.com>
Authored: Fri Oct 28 10:44:13 2016 -0700
Committer: Scott Wegner <sw...@google.com>
Committed: Fri Oct 28 10:44:13 2016 -0700
----------------------------------------------------------------------
contribute/contribution-guide.md | 33 ++++++++++++++++++++++++++++++---
1 file changed, 30 insertions(+), 3 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-beam-site/blob/db18665a/contribute/contribution-guide.md
----------------------------------------------------------------------
diff --git a/contribute/contribution-guide.md b/contribute/contribution-guide.md
index 88c3884..a7c82b1 100644
--- a/contribute/contribution-guide.md
+++ b/contribute/contribution-guide.md
@@ -95,9 +95,36 @@ You are now ready to start developing!
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)._
+##### IntelliJ
+
+_This documentation is incomplete. If you are an Intellij user, please contribute instructions!
+See [BEAM-835](https://issues.apache.org/jira/browse/BEAM-835)._
+
+###### Checkstyle
+IntelliJ supports checkstyle within the IDE using the Checkstyle-IDEA plugin.
+
+1. Install the "Checkstyle-IDEA" plugin from the IntelliJ plugin repository.
+1. Configure the plugin by going to Settings -> Other Settings -> Checkstyle.
+1. Set the "Scan Scope" to "Only Java sources (including tests)".
+1. In the "Configuration File" pane, add a new configuration using the plus icon:
+ 1. Set the "Description" to "Beam".
+ 1. Select "Use a local Checkstyle file", and point it to
+ "sdks/java/build-tools/src/main/resources/beam/checkstyle.xml" within
+ your repository.
+ 1. Check the box for "Store relative to project location", and click
+ "Next".
+ 1. Configure the "checkstyle.suppressions.file" property value to
+ "suppressions.xml", and click "Next", then "Finish".
+1. Select "Beam" as the only active configuration file, and click "Apply" and
+ "OK".
+1. Checkstyle will now give warnings in the editor for any Checkstyle
+ violations.
+
+You can also scan an entire module by opening the Checkstyle tools window and
+clicking the "Check Module" button. The scan should report no errors.
+
+Note: Selecting "Check Project" may report some errors from the archetype
+modules as they are not configured for Checkstyle validation.
##### Eclipse
[2/2] incubator-beam-site git commit: This closes #55
Posted by ke...@apache.org.
This closes #55
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/c60d9690
Tree: http://git-wip-us.apache.org/repos/asf/incubator-beam-site/tree/c60d9690
Diff: http://git-wip-us.apache.org/repos/asf/incubator-beam-site/diff/c60d9690
Branch: refs/heads/asf-site
Commit: c60d96902c95a5a87dc29897344f201f6b43047f
Parents: 6f08791 db18665
Author: Kenneth Knowles <kl...@google.com>
Authored: Sun Oct 30 20:43:56 2016 -0700
Committer: Kenneth Knowles <kl...@google.com>
Committed: Sun Oct 30 20:43:56 2016 -0700
----------------------------------------------------------------------
contribute/contribution-guide.md | 33 ++++++++++++++++++++++++++++++---
1 file changed, 30 insertions(+), 3 deletions(-)
----------------------------------------------------------------------