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

[KYUUBI #932] [DOC] Update collaborators page and correct terminology KPIP usage

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/apache/incubator-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.
-->
Partly fix #876

### _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/develop_tools/testing.html#running-tests) locally before make a pull request

Closes #932 from pan3793/doc.

Closes #932

43df4766 [Cheng Pan] switch to https
8d6e9761 [Cheng Pan] Correct terminology KPIP usage
dd813af2 [Cheng Pan] Update collaborators

Authored-by: Cheng Pan <chengpan@apache.org>
Signed-off-by: Cheng Pan <chengpan@apache.org>
This commit is contained in:
Cheng Pan 2021-08-16 19:33:29 +08:00
parent c0606713e7
commit 396310670a
No known key found for this signature in database
GPG Key ID: F07E6C29ED4E2E5B
2 changed files with 24 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/community/collaborators.md
View File

@ -1,10 +1,5 @@
# Collaborators
Name | GitHub ID | Corp
--- | --- | ---
Kent Yao | @yaooqinn | NetEase Inc
ulysses-you | @ulysses-you | NetEase Inc
Cheng Pan | @pan3793 | Individual
Fei Wang | @turbofei | eBay Inc
[PPMC Members and Committers](https://people.apache.org/phonebook.html?podling=kyuubi)
See full contributor list at [contributors](https://github.com/apache/incubator-kyuubi/graphs/contributors).

46
docs/community/improvement-proposals.md
View File

@ -4,50 +4,50 @@
</div>
# Kyuubi Project Improvement Proposals (KBIP)
# Kyuubi Project Improvement Proposals (KPIP)
The purpose of a KBIP is to inform and involve the user community in significant improvements to the Kyuubi codebase throughout the development process to increase user needs.
The purpose of a KPIP is to inform and involve the user community in significant improvements to the Kyuubi codebase throughout the development process to increase user needs.
KBIPs should be used for significant user-facing or cross-cutting changes, not minor incremental improvements. When in doubt, if a committer thinks a change needs a KBIP, it does.
KPIPs should be used for significant user-facing or cross-cutting changes, not minor incremental improvements. When in doubt, if a committer thinks a change needs a KPIP, it does.
## What is a KBIP?
## What is a KPIP?
A KBIP is similar to a product requirement document commonly used in product management.
A KPIP is similar to a product requirement document commonly used in product management.
A KBIP:
A KPIP:
- Is a ticket labeled “KBIP” proposing a major improvement or change to Kyuubi
- Is a ticket labeled “KPIP” proposing a major improvement or change to Kyuubi
- Follows the template defined below
- Includes discussions on the ticket about the proposal
## Who?
Any **community member** can help by discussing whether a KBIP is likely to meet their needs and propose KBIPs.
Any **community member** can help by discussing whether a KPIP is likely to meet their needs and propose KPIPs.
**Contributors** can help by discussing whether a KBIP is likely to be technically feasible.
**Contributors** can help by discussing whether a KPIP is likely to be technically feasible.
**Committers** can help by discussing whether a KBIP aligns with long-term project goals, and by shepherding KBIPs.
**Committers** can help by discussing whether a KPIP aligns with long-term project goals, and by shepherding KPIPs.
**KBIP Author** is any community member who authors a KBIP and is committed to pushing the change through the entire process. KBIP authorship can be transferred.
**KPIP Author** is any community member who authors a KPIP and is committed to pushing the change through the entire process. KPIP authorship can be transferred.
**KBIP Shepherd** is a PMC member who is committed to shepherding the proposed change throughout the entire process. Although the shepherd can delegate or work with other committers in the development process, the shepherd is ultimately responsible for the success or failure of the KBIP. Responsibilities of the shepherd include, but are not limited to:
**KPIP Shepherd** is a PMC member who is committed to shepherding the proposed change throughout the entire process. Although the shepherd can delegate or work with other committers in the development process, the shepherd is ultimately responsible for the success or failure of the KPIP. Responsibilities of the shepherd include, but are not limited to:
- Be the advocate for the proposed change
- Help push forward on design and achieve consensus among key stakeholders
- Review code changes, making sure the change follows project standards
- Get feedback from users and iterate on the design & implementation
- Uphold the quality of the changes, including verifying whether the changes satisfy the goal of the KBIP and are absent of critical bugs before releasing them
- Uphold the quality of the changes, including verifying whether the changes satisfy the goal of the KPIP and are absent of critical bugs before releasing them
## KBIP Process
### Proposing a KBIP
## KPIP Process
### Proposing a KPIP
Anyone may propose a KBIP, using the document template below. Please only submit a KBIP if you are willing to help, at least with discussion.
Anyone may propose a KPIP, using the document template below. Please only submit a KPIP if you are willing to help, at least with discussion.
If a KBIP is too small or incremental and should have been done through the normal JIRA process, a committer should remove the KBIP label.
If a KPIP is too small or incremental and should have been done through the normal JIRA process, a committer should remove the KPIP label.
### KBIP Document Template
### KPIP Document Template
A KBIP document is a short document with a few questions, inspired by the Heilmeier Catechism:
A KPIP document is a short document with a few questions, inspired by the Heilmeier Catechism:
- Q1. What are you trying to do? Articulate your objectives using absolutely no jargon.
@ -71,10 +71,10 @@ A KBIP document is a short document with a few questions, inspired by the Heilme
- Appendix C. Optional Rejected Designs: What alternatives were considered? Why were they rejected? If no alternatives have been considered, the problem needs more thought.
### Discussing a KBIP
### Discussing a KPIP
All discussions of a KBIP should take place in a public forum, preferably the discussion attached to the ticket. Any discussion that happen offline should be made available online for the public via meeting notes summarizing the discussions.
All discussions of a KPIP should take place in a public forum, preferably the discussion attached to the ticket. Any discussion that happen offline should be made available online for the public via meeting notes summarizing the discussions.
### Implementing a KBIP
### Implementing a KPIP
Implementation should take place via the [contribution guidelines](./contributions.md). Changes that require KBIPs typically also require design documents to be written and reviewed.
Implementation should take place via the [contribution guidelines](./contributions.md). Changes that require KPIPs typically also require design documents to be written and reviewed.