singa-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From GitBox <...@apache.org>
Subject [GitHub] [singa] nudles commented on a change in pull request #581: Code format linting
Date Wed, 29 Jan 2020 09:09:01 GMT
nudles commented on a change in pull request #581: Code format linting
URL: https://github.com/apache/singa/pull/581#discussion_r372262411
 
 

 ##########
 File path: tool/code-format/README.md
 ##########
 @@ -0,0 +1,49 @@
+<!--
+    Licensed to the Apache Software Foundation (ASF) under one
+    or more contributor license agreements.  See the NOTICE file
+    distributed with this work for additional information
+    regarding copyright ownership.  The ASF licenses this file
+    to you under the Apache License, Version 2.0 (the
+    "License"); you may not use this file except in compliance
+    with the License.  You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+    Unless required by applicable law or agreed to in writing,
+    software distributed under the License is distributed on an
+    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+    KIND, either express or implied.  See the License for the
+    specific language governing permissions and limitations
+    under the License.
+-->
+
+# How to format code
+
+This guide is for singa devoloper who should sanitize the code
+before merging into the main branch.
+
+## tools to auto formating code
+
+Install clang-format for C++:
+
+Ubuntu 16.04: `sudo apt install clang-format`
+
+Ubuntu 18.04: `sudo apt install clang-format-6.0`
+
+
+Install yapf for Python:
+
+`pip install yapf`
+
+## Formating a single file
+
+- C++: `clang-format -i path/to/file`
+
+- Python: `yapf -i path/to/file`
 
 Review comment:
   http://singa.apache.org/develop/contribute-code.html
   need to update the instructions on how to configure the vs editor to use the cfg files
in this PR.

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services

Mime
View raw message