10d0aecde1
# 🔍 Description ## Issue References 🔗 This pull request fixes #5701 ## Describe Your Solution 🔧 This PR updates the PR template to ensure that PR authors provide informative PR descriptions for reviewers to speed up the review process. It's also suitable for improving our code quality. Besides, `docs/contributing/code/style.rst` is also changed to add a link to the doc style so that we can keep the PR template neat. ## Types of changes 🔖 - [ ] Bugfix (non-breaking change which fixes an issue) - [x] New feature (non-breaking change which adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to change) ## Test Plan 🧪 #### Behavior Without This Pull Request ⚰️ See the screenshot below.  #### Behavior With This Pull Request 🎉 It's able to check it from the description of this PR directly. #### Related Unit Tests No --- # Checklists ## 📝 Author Self Checklist - [x] My code follows the [style guidelines](https://kyuubi.readthedocs.io/en/master/contributing/code/style.html) of this project - [x] I have performed a self-review - [ ] I have commented my code, particularly in hard-to-understand areas - [x] I have made corresponding changes to the documentation - [x] My changes generate no new warnings - [ ] I have added tests that prove my fix is effective or that my feature works - [x] New and existing unit tests pass locally with my changes - [x] This patch was authored or co-authored using [Generative Tooling](https://www.apache.org/legal/generative-tooling.html) ## 📝 Committer Pre-Merge Checklist - [x] Pull request title is okay. - [x] No license issues. - [x] Milestone correctly set? - [x] Test coverage is ok - [x] Assignees are selected. - [x] Minimum number of approvals - [x] No changes are requested **Be nice. Be informative.** Closes #5702 from yaooqinn/pr. Closes #5701 19bdea9a4 [Kent Yao] not d7d9d8cfa [Kent Yao] Enhance PR Template to make PR desc informative be026e4a6 [Kent Yao] Enhance PR Template to make PR desc informative Authored-by: Kent Yao <yao@apache.org> Signed-off-by: Kent Yao <yao@apache.org>
45 lines
1.8 KiB
ReStructuredText
45 lines
1.8 KiB
ReStructuredText
.. 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 |