| .. 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. |
| |
| Code Style Guide |
| ================ |
| |
| Code is written once by its author, but read and modified multiple times by |
| lots of other engineers. As most bugs actually come from future modification |
| of the code, we need to optimize our codebase for long-term, global |
| readability and maintainability. The best way to achieve this is to write |
| simple code. |
| |
| Kyuubi's source code is multilingual, specific code style will be applied to |
| corresponding language. |
| |
| Scala Coding Style Guide |
| ------------------------ |
| |
| Kyuubi adopts the `Databricks Scala Coding Style Guide`_ for scala codes. |
| |
| Java Coding Style Guide |
| ----------------------- |
| |
| Kyuubi adopts the `Google Java style`_ for java codes. |
| |
| Documentation Style Guide |
| ------------------------- |
| |
| Kyuubi adopts the `Documentation Style Guide`_ for documentation. |
| |
| .. _Databricks Scala Coding Style Guide: https://github.com/databricks/scala-style-guide |
| .. _Google Java style: https://google.github.io/styleguide/javaguide.html |
| .. _Documentation Style Guide: ../doc/style.html |
