apache/kyuubi
1
0
Fork 0
Code Issues Pull Requests Actions 5 Packages Projects Releases Wiki Activity

[KYUUBI #533] improve contribution guidelines

Browse Source 
<!--
Thanks for sending a pull request!

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
  2. If the PR is related to an issue in https://github.com/yaooqinn/kyuubi/issues, add '[KYUUBI #XXXX]' in your PR title, e.g., '[KYUUBI #XXXX] Your PR title ...'.
  3. If the PR is unfinished, add '[WIP]' in your PR title, e.g., '[WIP][KYUUBI #XXXX] Your PR title ...'.
-->

### _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 use case of it.
  2. If you fix a bug, you can clarify why it is a bug.
-->
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 <ulyssesyou18@gmail.com>
Signed-off-by: ulysses-you <ulyssesyou18@gmail.com>
This commit is contained in:
ulysses-you 2021-04-16 13:04:58 +08:00
parent 53ba63cd61
commit d397eb2cf1
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/community/contributions.md
View File

@ -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.