From c6bf6ebf9ee131252632cfd34ff0fa7905fd0525 Mon Sep 17 00:00:00 2001 From: Kent Yao Date: Thu, 14 Jan 2021 20:28:30 +0800 Subject: [PATCH] PR ISSUE and Contribution Guide (#287) --- .../pull_request_template.md | 13 ++++++++ .github/pr-badge.yml | 26 +++++++++++++++ .travis.yml | 16 +++++----- CONTRIBUTING.md | 3 -- docs/community/{index.md => badges.md} | 0 docs/community/contributions.md | 32 +++++++++++++++++++ docs/community/index.rst | 13 ++++++++ 7 files changed, 92 insertions(+), 11 deletions(-) create mode 100644 .github/PULL_REQUEST_TEMPLATE/pull_request_template.md create mode 100644 .github/pr-badge.yml delete mode 100644 CONTRIBUTING.md rename docs/community/{index.md => badges.md} (100%) create mode 100644 docs/community/contributions.md create mode 100644 docs/community/index.rst diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md new file mode 100644 index 000000000..e07c92262 --- /dev/null +++ b/.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 + diff --git a/.github/pr-badge.yml b/.github/pr-badge.yml new file mode 100644 index 000000000..045a7e21c --- /dev/null +++ b/.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')" diff --git a/.travis.yml b/.travis.yml index d3170fdd5..eae98b6c5 100644 --- a/.travis.yml +++ b/.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 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index 45aa22914..000000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,3 +0,0 @@ -## Contributing to Kyuubi - -All helps are welcome. Thanks. diff --git a/docs/community/index.md b/docs/community/badges.md similarity index 100% rename from docs/community/index.md rename to docs/community/badges.md diff --git a/docs/community/contributions.md b/docs/community/contributions.md new file mode 100644 index 000000000..82bb4d0c5 --- /dev/null +++ b/docs/community/contributions.md @@ -0,0 +1,32 @@ + + +# 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 Issue +- Better to create an Issue 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 diff --git a/docs/community/index.rst b/docs/community/index.rst new file mode 100644 index 000000000..36526b2c9 --- /dev/null +++ b/docs/community/index.rst @@ -0,0 +1,13 @@ +.. image:: ../imgs/kyuubi_logo.png + :align: center + +Community +========= + +.. toctree:: + :maxdepth: 2 + :numbered: 4 + :glob: + + contributions + badges