This is an automated email from the ASF dual-hosted git repository.
yao pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-kyuubi-website.git
The following commit(s) were added to refs/heads/master by this push:
new be9d1ee Refactor contribution page (#47)
be9d1ee is described below
commit be9d1ee221460c77ac84b53ef435255f9a214649
Author: ulysses <[email protected]>
AuthorDate: Wed Mar 9 16:52:13 2022 +0800
Refactor contribution page (#47)
* contribution
* pull request
* pull request
* notifactions
---
.asf.yaml | 5 +++-
src/contributing.md | 82 -----------------------------------------------------
src/pull_request.md | 73 +++++++++++++++++++++++++++++++++++++++++++++++
3 files changed, 77 insertions(+), 83 deletions(-)
diff --git a/.asf.yaml b/.asf.yaml
index 8b2a397..e5d4255 100644
--- a/.asf.yaml
+++ b/.asf.yaml
@@ -22,7 +22,10 @@ github:
squash: true
merge: false
rebase: false
-notifications: ~
+notifications:
+ commits: [email protected]
+ issues: [email protected]
+ pullrequests: [email protected]
staging:
profile: ~
whoami: asf-site
diff --git a/src/contributing.md b/src/contributing.md
deleted file mode 100644
index 61ad747..0000000
--- a/src/contributing.md
+++ /dev/null
@@ -1,82 +0,0 @@
----
-title: Contributing
-menu:
- main:
- name: "Contributing to Kyuubi"
- parent: "community"
----
-<!---
- Licensed under the Apache License, Version 2.0 (the "License");
- you may not use this file except in compliance with the License.
- You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- See the License for the specific language governing permissions and
- 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.
-
-- 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.
-
-## 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/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
-
-When creating a Pull Request, you will automatically get the template below.
-
-Fulfilling it thoroughly can improve the speed of the review process.
-
-```
-<!--
-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
--->
-
-### _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}
-
-### _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.
--->
-
-
-### _How was this patch tested?_
-- [ ] 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/src/pull_request.md b/src/pull_request.md
new file mode 100644
index 0000000..42c29b0
--- /dev/null
+++ b/src/pull_request.md
@@ -0,0 +1,73 @@
+---
+title: Contributing
+menu:
+ main:
+ name: "Pull Request"
+ parent: "community"
+---
+<!---
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License. See accompanying LICENSE file.
+-->
+
+# Review pull requests
+
+Kyuubi 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/).
+
+# Submit your pull requests
+
+## Before
+
+Before proceeding, it's better to search the issues and pull requests history
first. Likely, the problem or request has been discussed.
+
+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. Set up your identifier
+ git config user.name "${Your_github_name}"
+ git config user.email "${Your_public_email}"
+# 5. Create a new branch
+ git checkout -b ${Your_branch_name}
+# 6. Do your develop and commit the changes
+ git commit -am "${Your_commit_information}"
+# 7. Push your branch to your repository
+ git push origin ${Your_branch_name}
+# 8. Go to 'https://github.com/apache/incubator-kyuubi' and click the 'new
pull request' button
+```
+
+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.
+See [Pull Request
Template](https://github.com/apache/incubator-kyuubi/blob/master/.github/PULL_REQUEST_TEMPLATE).
+
+## After
+
+It may take some time to wait other developer to review. Feel free to ping any
committer who has worked on the similar area.
+In general, You can find out the right people to review your code through git
commit history.
+
+One more thing, Kyuubi leverage github action to cover unit test and
integration test, so please make sure your pull request's
+tests are green. It will Speed up the merging :).
