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.

Prepare github environment

If you are new to submit a Pull Request, the follow steps are helpful to you.

  1. An available git, you can run git version if you not sure you have
  2. Fork 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, 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.

  1. <!--
  2. Thanks for sending a pull request!
  4. Here are some tips for you:
  5.   1. If this is your first time, please read our contributor guidelines:
  6.      https://kyuubi.readthedocs.io/en/latest/community/contributions.html
  7. -->
  9. ### _Which issue are you going to fix?_
  10. <!--
  11. Replace ${ID} below with the actual issue id from
  12. https://github.com/apache/incubator-kyuubi/issues,
  13. so that the issue will be linked and automatically closed after merging
  14. -->
  16. Fixes #${ID}
  18. ### _Why are the changes needed?_
  19. <!--
  20. Please clarify why the changes are needed. For instance,
  21.   1. If you add a feature, you can talk about the user case of it.
  22.   2. If you fix a bug, you can clarify why it is a bug.
  23. -->
  26. ### _How was this patch tested?_
  27. - [ ] Add some test cases that check the changes thoroughly including negative and positive cases if possible
  29. - [ ] Add screenshots for manual tests if appropriate
  31. - [ ] [Run test](https://kyuubi.readthedocs.io/en/latest/develop_tools/testing.html#running-tests) locally before make a pull request