diff --git a/README.md b/README.md index 5b8f360ad..5bcb2877f 100644 --- a/README.md +++ b/README.md @@ -63,9 +63,15 @@ All bits of help are welcome. You can make various types of contributions to Kyu - Promote to others - Click the star button if you like this project +Before you start, we recommend that you check the [Contribution Guidelines](https://kyuubi.readthedocs.io/en/latest/community/contributions.html) first. + ## Aside The project took its name from a character of a popular Japanese manga - `Naruto`. The character is named `Kyuubi Kitsune/Kurama`, which is a nine-tailed fox in mythology. `Kyuubi` spread the power and spirit of fire, which is used here to represent the powerful [Apache Spark](http://spark.apache.org). It's nine tails stands for end-to-end multi-tenancy support of this project. + +## License + +This project is licensed under the Apache 2.0 License. See the [LICENSE](./LICENSE) file for details. diff --git a/docs/community/contributions.md b/docs/community/contributions.md index 82bb4d0c5..67a17658a 100644 --- a/docs/community/contributions.md +++ b/docs/community/contributions.md @@ -19,14 +19,37 @@ When creating a Pull Request, you will automatically get the template below. Fulfilling it thoroughly can improve the speed of the review process. - ### Please clarify what changes you are proposing - A few sentences describing the overall goals of the pull request's commits. - - ### Please add issue ID here? - - Fixes #{issue ID} - replace ${issue ID} with the actual issue id. - - ### Test Plan: - - 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 locally before make a pull request https://kyuubi.readthedocs.io/en/latest/tools/testing.html#running-tests +``` + + +### _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 + +```