kyuubi/docs
Kent Yao 10d0aecde1
[KYUUBI #5701] Enhance the PR Template to make PR desc informative
# 🔍 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.
![image](https://github.com/apache/kyuubi/assets/8326978/94a71e97-a573-47d9-8f44-f84b0f38db72)

#### 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>
2023-11-15 18:36:47 +08:00
..
_static/css
appendix [KYUUBI #4655] [DOCS] Enrich docs for Kyuubi Hive JDBC driver 2023-04-03 18:51:27 +08:00
client [KYUUBI #5683] Add kyuubi.session.proxy.user as an alternative to hive.server2.proxy.user 2023-11-13 20:08:33 +08:00
community [KYUUBI #5273] Update release docs 2023-09-12 10:49:59 +08:00
configuration [KYUUBI #5582] JDBC Engine supports configurable default fetchSize 2023-11-15 12:15:05 +08:00
connector [KYUUBI #4614] [DOCS] Rename Flink Table Store to Apache Paimon (Incubating) in docs Connectors for Flink SQL Query Engine 2023-03-27 13:04:42 +08:00
contributing [KYUUBI #5701] Enhance the PR Template to make PR desc informative 2023-11-15 18:36:47 +08:00
deployment [KYUUBI #5423] Support chaining SessionConfAdvisors 2023-10-30 09:48:25 +08:00
extensions [KYUUBI #5118][DOC] Add Flink KDF doc 2023-09-07 14:49:57 +08:00
imgs [KYUUBI #4371] Fix typo in kyuubi_ecosystem.drawio 2023-02-20 13:00:45 +08:00
monitor [KYUUBI #5365] Don't use Log4j2's extended throwable conversion pattern in default logging configurations 2023-10-11 21:41:22 +08:00
overview [KYUUBI #4624] [Docs] Fix table headers in kyuubi_vs_hive.md 2023-03-28 16:40:35 +08:00
quick_start [KYUUBI #5523] [DOC] Update the Kyuubi supported components version 2023-10-25 22:12:08 +08:00
security [KYUUBI #5427] [AUTHZ] Shade spark authz plugin 2023-10-20 20:10:34 +08:00
tools Revert "[KYUUBI #4994][REST] Support listing all engines" 2023-11-03 00:25:18 +08:00
conf.py [KYUUBI #4768] [INFRA] Guidelines for Document and Code contributions 2023-04-27 19:58:10 +08:00
index.rst [KYUUBI #5154] [Doc] Move configuration docs to the top level 2023-08-11 18:23:08 +08:00
make.bat [KYUUBI #4235] [DOCS] Prefer https:// URLs in docs 2023-02-03 14:01:11 +08:00
Makefile
requirements.txt [KYUUBI #4768] [INFRA] Guidelines for Document and Code contributions 2023-04-27 19:58:10 +08:00