[incubator-pinot] branch master updated: Doc coding guidelines (#3884)

[mc...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

mcvsubbu pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-pinot.git


The following commit(s) were added to refs/heads/master by this push:
     new 2da1157  Doc coding guidelines (#3884)
2da1157 is described below

commit 2da11579138c2e9b709803d5faaf15ca3320ff80
Author: Subbu Subramaniam <mc...@users.noreply.github.com>
AuthorDate: Tue Feb 26 08:58:28 2019 -0800

    Doc coding guidelines (#3884)
    
    * Added a coding guidelines section
    
    * Added a TODO for eclipse
---
 docs/{index.rst => coding_guidelines.rst} | 48 ++++++++++++-------------------
 docs/index.rst                            |  8 ++++++
 2 files changed, 26 insertions(+), 30 deletions(-)

diff --git a/docs/index.rst b/docs/coding_guidelines.rst
similarity index 56%
copy from docs/index.rst
copy to docs/coding_guidelines.rst
index 9eb8531..3c415d6 100644
--- a/docs/index.rst
+++ b/docs/coding_guidelines.rst
@@ -17,43 +17,31 @@
 .. under the License.
 ..
 
-.. Pinot documentation master file, created by
-   sphinx-quickstart on Fri Feb  9 14:54:43 2018.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
+Coding Guidelines
+=================
 
-############
-Introduction
-############
+To contribute to Pinot, please follow the code-style as described below:
 
+Intellij
+^^^^^^^^
 
-.. toctree::
-   :maxdepth: 1
+* `Import <https://www.jetbrains.com/help/idea/settings-code-style.html>`_ code style to Intellij
+* Navigate to ``Preferences`` -> ``Editor`` -> ``Code Style`` -> ``Java``
+* Select ``Import Scheme`` -> ``Intellij IDES code style XML``
+* Choose ``codestyle-intellij.xml``
 
-   intro
-   architecture
-   trying_pinot
+Eclipse
+^^^^^^^
+.. todo::
 
-#########
-Reference
-#########
+   Add instructions for eclipse here
 
-.. toctree::
-   :maxdepth: 1
+Verifying code-style
+^^^^^^^^^^^^^^^^^^^^
 
+Run the following command to verify the code-style before posting a PR
 
-   reference
-   in_production
+.. code-block:: none
 
-#################
-Customizing Pinot
-#################
-
-.. toctree::
-   :maxdepth: 1
-
-
-   pluggable_streams
-   segment_fetcher
-   pluggable_storage
+    mvn checkstyle:check
 
diff --git a/docs/index.rst b/docs/index.rst
index 9eb8531..aa6830d 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -57,3 +57,11 @@ Customizing Pinot
    segment_fetcher
    pluggable_storage
 
+################
+Getting Involved
+################
+
+.. toctree::
+   :maxdepth: 1
+
+   coding_guidelines


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@pinot.apache.org
For additional commands, e-mail: commits-help@pinot.apache.org