Author: wangsh
Date: Sat Jun 20 12:00:10 2015
New Revision: 1686579
URL: http://svn.apache.org/r1686579
Log:
add coding style guide
Modified:
incubator/singa/site/trunk/content/markdown/develop/contribute-code.md
Modified: incubator/singa/site/trunk/content/markdown/develop/contribute-code.md
URL:
http://svn.apache.org/viewvc/incubator/singa/site/trunk/content/markdown/develop/contribute-code.md?rev=1686579&r1=1686578&r2=1686579&view=diff
==============================================================================
--- incubator/singa/site/trunk/content/markdown/develop/contribute-code.md
(original)
+++ incubator/singa/site/trunk/content/markdown/develop/contribute-code.md Sat
Jun 20 12:00:10 2015
@@ -1,13 +1,21 @@
-## How to Contribute Code
+## how to Contribute Code
_____
+### coding Style
+
+the SINGA codebase follows the [Google C++ Style
Guide](http://google-styleguide.googlecode.com/svn/trunk/cppguide.xml)
+
+To check if your code follows the style, you can use the cpplint tool:
+
+ $ ./tool/cpplint.py YOUR_FILE
+
+### JIRA format
+
Like other Apache projects, SINGA uses JIRA to track bugs, improvements and
other high-level discussions (e.g., system design and features). Github pull
requests are
used for implementation discussions, e.g., code review and code merge.
-### JIRA format
-
* Provide a descriptive Title.
* Write a detailed Description. For bug reports, this should ideally include a
short reproduction of the problem. For new features, it may include a design
