You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@beam.apache.org by al...@apache.org on 2016/10/31 16:19:54 UTC
[50/51] [abbrv] [partial] incubator-beam-site git commit: Rebuild site
http://git-wip-us.apache.org/repos/asf/incubator-beam-site/blob/141627ec/content/contribute/contribution-guide/index.html
----------------------------------------------------------------------
diff --git a/content/contribute/contribution-guide/index.html b/content/contribute/contribution-guide/index.html
index a1b1aaa..8a1b810 100644
--- a/content/contribute/contribution-guide/index.html
+++ b/content/contribute/contribution-guide/index.html
@@ -161,7 +161,10 @@
<li><a href="#fork-the-repository-on-github" id="markdown-toc-fork-the-repository-on-github">Fork the repository on GitHub</a></li>
<li><a href="#clone-the-repository-locally" id="markdown-toc-clone-the-repository-locally">Clone the repository locally</a></li>
<li><a href="#optional-ide-setup" id="markdown-toc-optional-ide-setup">[Optional] IDE Setup</a> <ul>
- <li><a href="#intellij" id="markdown-toc-intellij">Intellij</a></li>
+ <li><a href="#intellij" id="markdown-toc-intellij">IntelliJ</a> <ul>
+ <li><a href="#checkstyle" id="markdown-toc-checkstyle">Checkstyle</a></li>
+ </ul>
+ </li>
<li><a href="#eclipse" id="markdown-toc-eclipse">Eclipse</a></li>
</ul>
</li>
@@ -296,9 +299,41 @@ $ cd incubator-beam
<p>Depending on your preferred development environment, you may need to prepare it to develop Beam code.</p>
-<h5 id="intellij">Intellij</h5>
+<h5 id="intellij">IntelliJ</h5>
-<p><em>If you are an Intellij user, please contribute instructions! See <a href="https://issues.apache.org/jira/browse/BEAM-835">BEAM-835</a>.</em></p>
+<p><em>This documentation is incomplete. If you are an Intellij user, please contribute instructions!
+See <a href="https://issues.apache.org/jira/browse/BEAM-835">BEAM-835</a>.</em></p>
+
+<h6 id="checkstyle">Checkstyle</h6>
+<p>IntelliJ supports checkstyle within the IDE using the Checkstyle-IDEA plugin.</p>
+
+<ol>
+ <li>Install the \u201cCheckstyle-IDEA\u201d plugin from the IntelliJ plugin repository.</li>
+ <li>Configure the plugin by going to Settings -> Other Settings -> Checkstyle.</li>
+ <li>Set the \u201cScan Scope\u201d to \u201cOnly Java sources (including tests)\u201d.</li>
+ <li>In the \u201cConfiguration File\u201d pane, add a new configuration using the plus icon:
+ <ol>
+ <li>Set the \u201cDescription\u201d to \u201cBeam\u201d.</li>
+ <li>Select \u201cUse a local Checkstyle file\u201d, and point it to
+ \u201csdks/java/build-tools/src/main/resources/beam/checkstyle.xml\u201d within
+ your repository.</li>
+ <li>Check the box for \u201cStore relative to project location\u201d, and click
+ \u201cNext\u201d.</li>
+ <li>Configure the \u201ccheckstyle.suppressions.file\u201d property value to
+ \u201csuppressions.xml\u201d, and click \u201cNext\u201d, then \u201cFinish\u201d.</li>
+ </ol>
+ </li>
+ <li>Select \u201cBeam\u201d as the only active configuration file, and click \u201cApply\u201d and
+\u201cOK\u201d.</li>
+ <li>Checkstyle will now give warnings in the editor for any Checkstyle
+violations.</li>
+</ol>
+
+<p>You can also scan an entire module by opening the Checkstyle tools window and
+clicking the \u201cCheck Module\u201d button. The scan should report no errors.</p>
+
+<p>Note: Selecting \u201cCheck Project\u201d may report some errors from the archetype
+modules as they are not configured for Checkstyle validation.</p>
<h5 id="eclipse">Eclipse</h5>