From d397eb2cf145d186b2ad09e78c31deb899dc5984 Mon Sep 17 00:00:00 2001 From: ulysses-you Date: Fri, 16 Apr 2021 13:04:58 +0800 Subject: [PATCH] [KYUUBI #533] improve contribution guidelines ### _Why are the changes needed?_ Add some git and github steps at contribution guidelines docs. Assuming most user in github has not experience with submit pull request. And this docs make things easy for new developer. Closes #533 from ulysses-you/improve-contribution-guidelines. Closes #533 ce116d2 [ulysses-you] nit d70b322 [ulysses-you] fix 70fb548 [ulysses-you] docs Authored-by: ulysses-you Signed-off-by: ulysses-you --- docs/community/contributions.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docs/community/contributions.md b/docs/community/contributions.md index 85160cce4..195b3be7b 100644 --- a/docs/community/contributions.md +++ b/docs/community/contributions.md @@ -13,6 +13,18 @@ Contributing to Kyuubi including source code, documents, tests e.t.c. means that 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.