ed6775856f
 [](https://github.com/yaooqinn/kyuubi/pull/327)      [❨?❩](https://pullrequestbadge.com/?utm_medium=github&utm_source=yaooqinn&utm_campaign=badge_info)<!-- PR-BADGE: PLEASE DO NOT REMOVE THIS COMMENT --> <!-- Thanks for sending a pull request! Here are some tips for you: 1. If this is your first time, please read our contributor guidelines: https://kyuubi.readthedocs.io/en/latest/community/contributions.html 2. If the PR is related to an issue in https://github.com/yaooqinn/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 ...'. --> ### _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. --> keep contribution guideline fresh ### _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 - [ ] [Run test](https://kyuubi.readthedocs.io/en/latest/tools/testing.html#running-tests) locally before make a pull request Closes #327 from yaooqinn/updatedoc. 861d434 [jhx1008] Update contribution guide Authored-by: jhx1008 <jhx1008@gmail.com> Signed-off-by: Kent Yao <yao@apache.org>
56 lines
2.4 KiB
Markdown
56 lines
2.4 KiB
Markdown
<script async defer src="https://buttons.github.io/buttons.js"></script>
|
|
|
|
# Contribution Guidelines
|
|
|
|
**Kyuubi** is an [Apache License v2.0](https://github.com/yaooqinn/kyuubi/blob/master/LICENSE) open source software.
|
|
|
|
Contributing to Kyuubi including source code, documents, tests e.t.c. means that you agree to the Apache License v2.0.
|
|
|
|
- Better to search the issue history first before reporting an <a class="github-button" href="https://github.com/yaooqinn/kyuubi/issues" data-color-scheme="no-preference: light; light: dark; dark: light;" data-icon="octicon-issue-opened" data-show-count="true" aria-label="Issue yaooqinn/kyuubi on GitHub">Issue</a>
|
|
- Better to create an <a class="github-button" href="https://github.com/yaooqinn/kyuubi/issues" data-color-scheme="no-preference: light; light: dark; dark: light;" data-icon="octicon-issue-opened" data-show-count="true" aria-label="Issue yaooqinn/kyuubi on GitHub">Issue</a> to describe the feature or bug first before make a pull request.
|
|
- Better to use English for world widely understanding.
|
|
- Ask us anything
|
|
|
|
Before you start, please read the [Code of Conduct](http://www.apache.org/foundation/policies/conduct.html) carefully, familiarize yourself with it and refer to it whenever you need it.
|
|
|
|
## Creating a Pull Request
|
|
|
|
When creating a Pull Request, you will automatically get the template below.
|
|
|
|
Fulfilling it thoroughly can improve the speed of the review process.
|
|
|
|
```
|
|
<!--
|
|
Thanks for sending a pull request!
|
|
|
|
Here are some tips for you:
|
|
1. If this is your first time, please read our contributor guidelines:
|
|
https://kyuubi.readthedocs.io/en/latest/community/contributions.html
|
|
-->
|
|
|
|
### _Which issue are you going to fix?_
|
|
<!--
|
|
Replace ${ID} below with the actual issue id from
|
|
https://github.com/yaooqinn/kyuubi/issues,
|
|
so that the issue will be linked and automatically closed after merging
|
|
-->
|
|
|
|
Fixes #${ID}
|
|
|
|
### _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 user case of it.
|
|
2. If you fix a bug, you can clarify why it is a bug.
|
|
-->
|
|
|
|
|
|
### _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
|
|
|
|
- [ ] [Run test](https://kyuubi.readthedocs.io/en/latest/tools/testing.html#running-tests) locally before make a pull request
|
|
|
|
```
|