PR ISSUE and Contribution Guide (#287)

.github/PULL_REQUEST_TEMPLATE/pull_request_template.md

@@ -0,0 +1,13 @@
+### 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](https://kyuubi.readthedocs.io/en/latest/tools/testing.html#running-tests) locally before make a pull request
+

.github/pr-badge.yml

@@ -0,0 +1,26 @@
+- label: "Hello"
+  message: "$payload.pull_request.user.login"
+  color: "green"
+
+- label: "Preview"
+  message: "PR $prNumber"
+  color: "blue"
+  url: "https://github.com/yaooqinn/kyuubi/pull/$prNumber"
+
+- label: "Missing"
+  message: "Target Issue"
+  color: "#ff0000"
+  when: "$payload.pull_request.body.includes('fixes # ') === false"
+
+- label: "Missing"
+  message: "Test Plan"
+  color: "#ff0000"
+  when: "$payload.pull_request.body.includes('## Test Plan ') === false"
+
+- label: "Label"
+  message: "Feature"
+  when: "$labels.includes('Feature')"
+
+- label: "Label"
+  message: "Bug"
+  when: "$labels.includes('Bug')"

.travis.yml

@@ -29,14 +29,14 @@ cache:
     - $HOME/.m2
 
 deploy:
-  - provider: pages
-    cleanup: false
-    keep_history: true
-    github_token: $GITHUB_TOKEN
-    email: yaooqinn@hotmail.com
-    name: Kent Yao
-    on:
-      branch: master
+#  - provider: pages
+#    cleanup: false
+#    keep_history: true
+#    github_token: $GITHUB_TOKEN
+#    email: yaooqinn@hotmail.com
+#    name: Kent Yao
+#    on:
+#      branch: master
 #  - provider: releases
 #    api_key: $GITHUB_TOKEN
 #    file_glob: true

CONTRIBUTING.md

@@ -1,3 +0,0 @@
-## Contributing to Kyuubi
-
-All helps are welcome. Thanks.

docs/community/contributions.md

@@ -0,0 +1,32 @@
+<script async defer src="https://buttons.github.io/buttons.js"></script>
+
+# Contribution Guidelines
+
+**Kyuubi** is an [Apache License v2.0](https://github.com/yaooqinn/kyuubi/blob/master/LICENSE) 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 <a class="github-button" href="https://github.com/yaooqinn/kyuubi/issues" data-color-scheme="no-preference: light; light: dark; dark: light;" data-icon="octicon-issue-opened" data-show-count="true" aria-label="Issue yaooqinn/kyuubi on GitHub">Issue</a>
+- Better to create an <a class="github-button" href="https://github.com/yaooqinn/kyuubi/issues" data-color-scheme="no-preference: light; light: dark; dark: light;" data-icon="octicon-issue-opened" data-show-count="true" aria-label="Issue yaooqinn/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.
+
+## 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.
+
+    ### 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

docs/community/index.rst

@@ -0,0 +1,13 @@
+.. image:: ../imgs/kyuubi_logo.png
+   :align: center
+
+Community
+=========
+
+.. toctree::
+    :maxdepth: 2
+    :numbered: 4
+    :glob:
+
+    contributions
+    badges