This is an automated email from the ASF dual-hosted git repository.
yao pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/kyuubi.git
The following commit(s) were added to refs/heads/master by this push:
new 10d0aecde [KYUUBI #5701] Enhance the PR Template to make PR desc
informative
10d0aecde is described below
commit 10d0aecde1cb9cd235bed42328e2e7cbe4039c5a
Author: Kent Yao <[email protected]>
AuthorDate: Wed Nov 15 18:36:47 2023 +0800
[KYUUBI #5701] Enhance the PR Template to make PR desc informative
# :mag: 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 :bookmark:
- [ ] 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 :coffin:
See the screenshot below.
#### Behavior With This Pull Request :tada:
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 <[email protected]>
Signed-off-by: Kent Yao <[email protected]>
---
.github/PULL_REQUEST_TEMPLATE | 72 ++++++++++++++++++++++++++--------------
docs/contributing/code/style.rst | 8 ++++-
2 files changed, 55 insertions(+), 25 deletions(-)
diff --git a/.github/PULL_REQUEST_TEMPLATE b/.github/PULL_REQUEST_TEMPLATE
index fa82ff5e7..6de5d0adc 100644
--- a/.github/PULL_REQUEST_TEMPLATE
+++ b/.github/PULL_REQUEST_TEMPLATE
@@ -1,32 +1,56 @@
-<!--
-Thanks for sending a pull request!
+# :mag: Description
+## Issue References ๐
+<!-- Append the issue number after #. If there is no issue for you to link
create one or -->
+<!-- If there are no issues to link, please provide details here. -->
-Here are some tips for you:
- 1. If this is your first time, please read our contributor guidelines:
https://kyuubi.readthedocs.io/en/master/community/CONTRIBUTING.html
- 2. If the PR is related to an issue in
https://github.com/apache/kyuubi/issues, add '[KYUUBI #XXXX]' in your PR title,
e.g., '[KYUUBI #XXXX] Your PR title ...'.
- 3. If the PR is unfinished, add '[WIP]' in your PR title, e.g.,
'[WIP][KYUUBI #XXXX] Your PR title ...'.
--->
+This pull request fixes #
-### _Why are the changes needed?_
-<!--
-Please clarify why the changes are needed. For instance,
- 1. If you add a feature, you can talk about the use case of it.
- 2. If you fix a bug, you can clarify why it is a bug.
--->
+## Describe Your Solution ๐ง
+Please include a summary of the change and which issue is fixed. Please also
include relevant motivation and context. List any dependencies that are
required for this change.
-### _How was this patch tested?_
-- [ ] Add some test cases that check the changes thoroughly including negative
and positive cases if possible
-- [ ] Add screenshots for manual tests if appropriate
+## Types of changes :bookmark:
+<!--- What types of changes does your code introduce? Put an `x` in all the
boxes that apply: -->
+- [ ] Bugfix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality
to change)
-- [ ] [Run
test](https://kyuubi.readthedocs.io/en/master/contributing/code/testing.html#running-tests)
locally before make a pull request
+## Test Plan ๐งช
+#### Behavior Without This Pull Request :coffin:
-### _Was this patch authored or co-authored using generative AI tooling?_
-<!--
-If a generative AI tooling has been used in the process of authoring this
patch, please include
-phrase 'Generated-by: ' followed by the name of the tool and its version.
-If no, write 'No'.
-Please refer to the [ASF Generative Tooling
Guidance](https://www.apache.org/legal/generative-tooling.html) for details.
--->
+
+#### Behavior With This Pull Request :tada:
+
+
+#### Related Unit Tests
+
+
+---
+
+# Checklists
+## ๐ Author Self Checklist
+<!--- Go over all the following points, and put an `x` in all the boxes that
apply. -->
+<!--- If you're unsure about any of these, don't hesitate to ask. We're here
to help! -->
+- [ ] My code follows the [style
guidelines](https://kyuubi.readthedocs.io/en/master/contributing/code/style.html)
of this project
+- [ ] I have performed a self-review
+- [ ] I have commented my code, particularly in hard-to-understand areas
+- [ ] I have made corresponding changes to the documentation
+- [ ] My changes generate no new warnings
+- [ ] I have added tests that prove my fix is effective or that my feature
works
+- [ ] New and existing unit tests pass locally with my changes
+- [ ] This patch was not authored or co-authored using [Generative
Tooling](https://www.apache.org/legal/generative-tooling.html)
+
+## ๐ Committer Pre-Merge Checklist
+
+- [ ] Pull request title is okay.
+- [ ] No license issues.
+- [ ] Milestone correctly set?
+- [ ] Test coverage is ok
+- [ ] Assignees are selected.
+- [ ] Minimum number of approvals
+- [ ] No changes are requested
+
+
+**Be nice. Be informative.**
diff --git a/docs/contributing/code/style.rst b/docs/contributing/code/style.rst
index d967e8959..fced388a3 100644
--- a/docs/contributing/code/style.rst
+++ b/docs/contributing/code/style.rst
@@ -35,5 +35,11 @@ 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
\ No newline at end of file
+.. _Google Java style: https://google.github.io/styleguide/javaguide.html
+.. _Documentation Style Guide: ../doc/style.html
\ No newline at end of file
