# Contribution Guidelines **Kyuubi** is an [Apache License v2.0](https://github.com/NetEase/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 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](http://www.apache.org/foundation/policies/conduct.html) carefully, familiarize yourself with it and refer to it whenever you need it. ## Prepare github environment If you are new to submit a Pull Request, the follow steps are helpful to you. 1. An available [git](https://git-scm.com/downloads), you can run `git version` if you not sure you have 2. Fork [Kyuubi](https://github.com/NetEase/kyuubi) on github, now you have a cloned Kyuubi repo 3. Clone your Kyuubi repo with cmd `git clone https://github.com/${yourname}/kyuubi.git` 4. Create a new branch with cmd `git checkout -b test-branch` 5. Modify the code you want 6. Commit and push code to your Kyuubi repo with commd `git commit -am "comment"; git push test-branch test-branch` 7. Back to [Kyuubi](https://github.com/NetEase/kyuubi), you can see a banner about `new pull request` 8. Now we can create a pull request to Kyuubi ## 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. ``` ### _Which issue are you going to fix?_ Fixes #${ID} ### _Why are the changes needed?_ ### _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 ```