diff --git a/.github/PULL_REQUEST_TEMPLATE b/.github/PULL_REQUEST_TEMPLATE index fa82ff5e789..6de5d0adccd 100644 --- a/.github/PULL_REQUEST_TEMPLATE +++ b/.github/PULL_REQUEST_TEMPLATE @@ -1,32 +1,56 @@ - + -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?_ - +## 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: + +- [ ] 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?_ - + +#### Behavior With This Pull Request :tada: + + +#### Related Unit Tests + + +--- + +# Checklists +## ๐Ÿ“ Author Self Checklist + + +- [ ] 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 d967e895971..fced388a3ed 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