kyuubi/docs/contributing
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
..
code [KYUUBI #5701] Enhance the PR Template to make PR desc informative 2023-11-15 18:36:47 +08:00
doc