2. Contribution Guidelines

Kyuubi is an Apache License v2.0 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 Issue

  • Better to create an Issue 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 carefully, familiarize yourself with it and refer to it whenever you need it.

2.1. 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:

### _Which issue are you going to fix?_
Replace ${ID} below with the actual issue id from
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