yaooqinn commented on a change in pull request #47: URL: https://github.com/apache/incubator-kyuubi-website/pull/47#discussion_r822355132
########## File path: src/contributing.md ########## @@ -19,64 +19,94 @@ menu: limitations under the License. See accompanying LICENSE file. --> -Contributing to Kyuubi including source code, documents, tests e.t.c. means that you agree to the Apache License v2.0. +Apache Kyuubi (Incubating) welcomes contribution from anyone. The contibution does not only about the code. +Subscribe and helping users on the mailing list, Come up with some features, Review other developers pull requests, +Improving documentation, Tell us your story are also welcome. This guide help you learn about the details of Kyuubi community. -- Better to search the issue history first before reporting an <a class="github-button" href="https://github.com/apache/incubator-kyuubi/issues"; data-color-scheme="no-preference: light; light: dark; dark: light;" data-icon="octicon-issue-opened" data-show-count="true" aria-label="Issue apache/incubator-kyuubi on GitHub">Issue</a> -- Better to create an <a class="github-button" href="https://github.com/apache/incubator-kyuubi/issues"; data-color-scheme="no-preference: light; light: dark; dark: light;" data-icon="octicon-issue-opened" data-show-count="true" aria-label="Issue apache/incubator-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. +# Mailing list -## Prepare github environment -If you are new to submit a Pull Request, the follow steps are helpful to you. +We discuss question or announce some important news through Kyuubi mailing list, such as the most popular +mailing [[email protected]](mailto:[email protected]). Subscribe mailing is a good start to join Kyuubi community. +See all Kyuubi supported [mailing list](https://kyuubi.apache.org/mailing_lists.html). -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/apache/incubator-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/apache/incubator-kyuubi), you can see a banner about `new pull request` -8. Now we can create a pull request to Kyuubi -## Creating a Pull Request +# Report bugs -When creating a Pull Request, you will automatically get the template below. +For bug reports, this should ideally include a short reproduction of the problem and it can also accelerate problem solving +if you can provide the used Kyuubi version and environment information details. Kyuubi use github issues to track and maintain the bug list. +See our [Bug Report Template](https://github.com/apache/incubator-kyuubi/issues/new?assignees=&labels=kind%3Abug%2Cpriority%3Amajor&template=bug-report.yml&title=%5BBug%5D+). -Fulfilling it thoroughly can improve the speed of the review process. -``` -<!-- -Thanks for sending a pull request! +# Request feature -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 ---> +As Kyuubi can be used in a wide variety of scenarios, the more and more features are merged into. Post your idea and describe your proposal to us. +See our [Feature Request Template](https://github.com/apache/incubator-kyuubi/issues/new?assignees=&labels=kind%3Afeature%2Cpriority%3Amajor&template=feature-request.yml&title=%5BFEATURE%5D+). -### _Which issue are you going to fix?_ -<!-- -Replace ${ID} below with the actual issue id from -https://github.com/apache/incubator-kyuubi/issues, -so that the issue will be linked and automatically closed after merging ---> -Fixes #${ID} +# Improve documentation -### _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. ---> +The documentation and code are maintained in the same project at Kyuubi, and the root directory of documentation is in `docs/`. +It would be great if you document some best practice with your use case. Including quick start, trouble shooting, deep optimization and so on. + + +# Share your story + +If your team has used Kyuubi for some time, we are looking forward to listen to your story. +See [Who is using Apache Kyuubi (Incubating)](https://github.com/apache/incubator-kyuubi/discussions/925). + +# Review pull requests + +Kyuubi also encourage to help review pull requests of other developers which makes code more robust. +The review guide can see [Google’s Engineering Practices documentation](https://google.github.io/eng-practices/review/). -### _How was this patch tested?_ -- [ ] Add some test cases that check the changes thoroughly including negative and positive cases if possible +# Contributing code changes -- [ ] Add screenshots for manual tests if appropriate +## Before -- [ ] [Run test](https://kyuubi.readthedocs.io/en/latest/tools/testing.html#running-tests) locally before make a pull request +Before proceeding, it's better to search the issues and pull requests history first. Likely, the problem or request has been discussed before. +After checking, you can create a new issue to describe what want to do, and about issues, we have rich types to +choose, see [here](https://github.com/apache/incubator-kyuubi/issues/new/choose). + +Then submit your code within a pull request. If you are a new contributor, please follow this guide to get a gentle step-by-step +introductionto setting up the development environment and making your first contribution. + +```shell +# 1. Fork the repository on GitHub +# Go to 'https://github.com/apache/incubator-kyuubi' and click the 'Fork' button to your repository +# 2. Clone the repository locally using follow git cmd + git clone https://github.com/${Github_user}/incubator-kyuubi.git + cd incubator-kyuubi +# 3. Add git remmote repository + git remote add origin https://github.com/${Github_user}/incubator-kyuubi.git + git remote add apache https://github.com/apache/incubator-kyuubi.git +# 4. Create a new branch + git checkout -b ${Your_branch_name} +# 5. Do your develop and commit the changes + git commit -am "${Your_commit_information}" +# 6. Push your branch to your repository + git push origin ${Your_branch_name} +# 7. Go to 'https://github.com/apache/incubator-kyuubi' and click the 'new pull request' button ``` + +About the pull request, it is highly recommended providing a clear descriptions for a better code review process. +Writing good pull request descriptions is a great way to help reviewers know what to expect when reviewing code. +As developers, our responsibility is to fix issues or implement new features and clearly communicate the development work to reviewers. +A developer can convey proposed code changes and their purposes either through detailed PR descriptions. +They're also a great way to help track things that should be done for every change, such as testing, adding unit tests, and updating documentation in the git log. + +Descriptions shall clearly answer: + +Q1. Review comment: what are the questions?.... -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
