This is an automated email from the ASF dual-hosted git repository. tison pushed a commit to branch refactor in repository https://gitbox.apache.org/repos/asf/incubator-kvrocks-website.git
commit 871732d55320523536aec5cd608e36de0a460a81 Author: tison <[email protected]> AuthorDate: Fri Dec 16 11:51:24 2022 +0800 Rework How to vote a Committer or PMC Member page Signed-off-by: tison <[email protected]> --- community/committers.md | 114 ------------------- community/how-to-vote-a-committer-pmc.md | 155 ------------------------- community/index.md | 10 +- community/vote-a-core-developer.md | 187 +++++++++++++++++++++++++++++++ docusaurus.config.js | 3 +- sidebarsCommunity.js | 25 +++++ 6 files changed, 217 insertions(+), 277 deletions(-) diff --git a/community/committers.md b/community/committers.md deleted file mode 100644 index 63bda23..0000000 --- a/community/committers.md +++ /dev/null @@ -1,114 +0,0 @@ ---- -title: Committers -sidebar_position: 4 ---- - -The development of Kvrocks is credited to the outstanding contributions from the folks in the community, who have helped get the project to where it's today. The committers wrere listed in alphabetical order by the GitHub id. - -### PMC - -<table class="table table-hover"> - <tr> - <th><b>Photo</b></th> - <th><b>Name</b></th> - <th><b>GitHub</b></th> - </tr> - <tr> - <td><a href="http://github.com/Alfejik";><img width="64" src="http://github.com/Alfejik.png"/></a></td> - <td>Donghui Liu</td> - <td><a href="http://github.com/Alfejik";>Alfejik</a></td> - </tr> - <tr> - <td><a href="http://github.com/chenliang613";><img width="64" src="http://github.com/chenliang613.png"/></a></td> - <td>Liang Chen</td> - <td><a href="http://github.com/chenliang613";>chenliang613</a></td> - </tr> - <tr> - <td><a href="http://github.com/git-hulk";><img width="64" src="http://github.com/git-hulk.png"/></a></td> - <td>Tianyi Lin</td> - <td><a href="http://github.com/git-hulk";>git-hulk</a></td> - </tr> - <tr> - <td><a href="http://github.com/Hexiaoqiao";><img width="64" src="http://github.com/Hexiaoqiao.png"/></a></td> - <td>Xiaoqiao He</td> - <td><a href="http://github.com/Hexiaoqiao";>Hexiaoqiao</a></td> - </tr> - <tr> - <td><a href="http://github.com/jbonofre";><img width="64" src="http://github.com/jbonofre.png"/></a></td> - <td>Jean-Baptiste Onofré</td> - <td><a href="http://github.com/jbonofre";>jbonofre</a></td> - </tr> - <tr> - <td><a href="https://github.com/PragmaTwice";><img width="64" src="https://github.com/PragmaTwice.png"/></a></td> - <td>Mingyang Liu</td> - <td><a href="https://github.com/PragmaTwice";>PragmaTwice</a></td> - </tr> - <tr> - <td><a href="https://github.com/ShooterIT";><img width="64" src="https://github.com/ShooterIT.png"/></a></td> - <td>Yuan Wang</td> - <td><a href="https://github.com/ShooterIT";>ShooterIT</a></td> - </tr> - <tr> - <td><a href="https://github.com/tisonkun";><img width="64" src="https://github.com/tisonkun.png"/></a></td> - <td>Zhili Chen</td> - <td><a href="https://github.com/tisonkun";>tison</a></td> - </tr> - <tr> - <td><a href="https://github.com/vongosling";><img width="64" src="https://github.com/vongosling.png"/></a></td> - <td>Jia Feng</td> - <td><a href="https://github.com/vongosling";>vongosling</a></td> - </tr> -</table> - -### Committers -<table class="table table-hover"> - <tr> - <th><b>Photo</b></th> - <th><b>Name</b></th> - <th><b>GitHub</b></th> - </tr> - <tr> - <td><a href="http://github.com/caipengbo";><img width="64" src="http://github.com/caipengbo.png"/></a></td> - <td>Pengbo Cai</td> - <td><a href="http://github.com/caipengbo";>caipengbo</a></td> - </tr> - <tr> - <td><a href="http://github.com/ChrisZMF";><img width="64" src="http://github.com/ChrisZMF.png"/></a></td> - <td>Mingfo Zou</td> - <td><a href="http://github.com/ChrisZMF";>ChrisZMF</a></td> - </tr> - <tr> - <td><a href="http://github.com/ColinChamber";><img width="64" src="http://github.com/ColinChamber.png"/></a></td> - <td>Jianhong Dong</td> - <td><a href="http://github.com/ColinChamber";>ColinChamber</a></td> - </tr> - <tr> - <td><a href="http://github.com/jeanbone";><img width="64" src="http://github.com/jeanbone.png"/></a></td> - <td>Jianbing Lai</td> - <td><a href="http://github.com/jeanbone";>jeanbone</a></td> - </tr> - <tr> - <td><a href="http://github.com/shangxiaoxiong";><img width="64" src="http://github.com/shangxiaoxiong.png"/></a></td> - <td>Xiaoxiong Shang</td> - <td><a href="http://github.com/shangxiaoxiong";>shangxiaoxiong</a></td> - </tr> - <tr> - <td><a href="http://github.com/smartlee";><img width="64" src="http://github.com/smartlee.png"/></a></td> - <td>Jian Li</td> - <td><a href="http://github.com/smartlee";>smartlee</a></td> - </tr> - <tr> - <td><a href="http://github.com/tanruixiang";><img width="64" src="http://github.com/tanruixiang.png"/></a></td> - <td>Ruixiang Tan</td> - <td><a href="http://github.com/tanruixiang";>tanruixiang</a></td> - </tr> - <tr> - <td><a href="http://github.com/torwig";><img width="64" src="http://github.com/torwig.png"/></a></td> - <td>Yaroslav</td> - <td><a href="http://github.com/torwig";>torwig</a></td> - </tr> -</table> - -### Contributors - -Thanks to [all the contributors](https://github.com/apache/incubator-kvrocks/graphs/contributors) making their effort to help Kvrocks community getting better. diff --git a/community/how-to-vote-a-committer-pmc.md b/community/how-to-vote-a-committer-pmc.md deleted file mode 100644 index 7c78539..0000000 --- a/community/how-to-vote-a-committer-pmc.md +++ /dev/null @@ -1,155 +0,0 @@ ---- -title: How to vote a Committer or PMC -sidebar_position: 1 ---- - -## Initiate discussion in the community private mailing group - Any Kvrocks PMC member can initiate a voting discussion. - After PMC finds any valuable contributions from community contributors and obtains the consent of the candidate, they can initiate a discussion on Kvrocks's private mailing list. - In the discussion email, the proposer should clearly state the candidate's contributions and give the address for reviewing the corresponding contributions, so that everyone can discuss and analyze it. - The discussion email is sent to `[email protected]`. The discussion will last at least 72 hours. PMC members will fully express their views on the proposed email. - - The following is a sample discussion email: - ```shell - [DISCUSS] XXXXXX for Kvrocks [committer|pmc] - - I nominate XXXXXX as an Kvrocks [committer|pmc] - - Judging from the contributions in recent months, XXXXXX has submitted many implementations[1],[2] to the project and improved the management module for the project. - During the optimization and improvement period of the project, it is hoped that more people will participate in the actual project optimization and improvement, - to let the project more perfect and easier to use. - - So I nominated XXXXXX as [committer|pmc] of the Kvrocks project. - - 1. https://github.com/apache/incubator-kvrocks/issues/created_by/XXXXXX - 2. https://github.com/apache/incubator-kvrocks/commits?author=XXXXXX - ``` - -## Initiate vote in the community private mailing group - - If the discussion email does not receive the disagreement information within the specified time, the poll initiator needs to initiate a Committer or PMC election vote on Kvrocks's private mailing list. - The voting email is sent to [email protected] for at least 72 hours, and at least 3 votes +1 passed; if 0 votes or 1 vote -1 vote, the vote will fail; if a -1 vote is initiated, the voter needs to EXPLAIN the reason for the -1 score clearly so that everyone can understand and know. - The following is a sample poll email: - ```shell - [VOTE] XXXXXX as a Kvrocks [Committer|pmc] - - Judging from contributions in recent months, XXXXXX has submitted many implementations[1],[2],[3] to the project and improved the management module for the project. During the optimization and improvement period of the project, it is hoped that more people will participate in the actual project optimization and improvement, to let the project more perfect and easier to use. - I think making him a [committer|pmc] will be a recognition of his outstanding work for Kvrocks. So, I am happy to call VOTE to accept XXXXXX as a Kvrocks [committer|pmc] - - Voting will continue for at least 72 hours or until the required number of votes is reached. - - Please vote accordingly: - [ ] +1 approve - [ ] +0 no opinion - [ ] -1 disapprove with the reason - - Here are three links to his contributions to Kvrocks: - 1. Issues: https://github.com/apache/incubator-kvrocks/pulls?q=XXXXXX - 2. PRs : https://github.com/apache/incubator-kvrocks/issues?q=XXXXXX - ``` - -## Feedback on voting results - After the voting email is over, the initiator of the vote needs to remind the voting end in the second [VOTE] email; at the same time, the initiator of the vote needs to initiate a vote summary email, and the summary email is sent to [email protected]. - The following is a sample vote summary email: - ```shell - [RESULTS][VOTE] XXXXXX as a Kvrocks[committer|pmc] - - Hi everyone, - - The vote for "XXXXXX as a Kvrocks [committer/pmc]" has PASSED and closed now. - - The result is as follows: - - 3 PMC +1 Votes - - aaa - - bbb - - ccc - - Vote thread: - https://lists.apache.org/thread/aaaaaxxxx - - Then I'm going to invite XXXXXX to join us. - - Thanks for everyone's support! - ``` - Note: If it is not passed, the result is "The vote for "XXXXXX as a Kvrocks [committer|pmc]" has FAILED and closed now." - -## Newly added PMC notification email - This step is only processed for the PMC that passed the vote. If the election is Committer, this step is skipped and not executed. - Voting initiators need to send notification emails to Board’s mailing group and wait at least 72 hours; email owners send [email protected] and CC [email protected]; Board will analyze compliance Until there is no doubt. - The following is an example of a new PMC notification email: - ```shell - [NOTICE] XXXXXX for Apache Kvrocks(incubating) PMC - - Hi everyone, - - Apache Kvrocks(incubating) proposes to invite XXXXXX to join the PMC. - - The vote result is available here: https://lists.apache.org/... - - Thanks! - ``` - -## Initiate invitation email - After the result summary email is sent, the poll initiator must send an invitation email to the candidates. - The invitation email is sent to the invitee with a CC to [email protected]; the invited candidate must reply to accept or decline the invitation through the specified email address. - The following is an example of an email inviting candidates: - ```shell - [Invitation] Invitation to join Apache Kvrocks as a [committer|pmc] - - Hi XXXXXX, - - In recognition of your contributions to Apache Kvrocks(incubating), the Kvrocks PMC - has recently voted to add you as a [committer|pmc]. The [committer|pmc] role gives - you access to merge patches into Apache Kvrocks(incubating) and is also a - stepping-stone towards membership in the - Project Management Committee (PMC). We hope that you accept - this invitation and continue to help us make Apache Kvrocks(incubating) better. - - If you'd like to accept, you will need to send an Individual - Contributor License Agreement (ICLA) to [email protected], CCing - [email protected], and request an Apache account name as - described at http://www.apache.org/dev/new-committers-guide.html if - you don’t already have one, once you get an account name, or if you - have one already, please email it to me. - - NOTICE: when you fill out ICLA file, the value of preferred Apache id(s) - needs to be a valid ID, including: - 1. The ID must not already be in use in https://people.apache.org/committer-index.html; - 2. The characters "-" and "_" are not allowed in id; - 3. The id must consist of lowercase alphanumeric characters only, - start with an alphabetic character, have a minimum length of 3 characters, - and have no special characters. - - With the expectation of your acceptance, welcome! - - The Apache Kvrocks(incubating) PMC - ``` - -## Processing after accepting the invitation - Create an Apache account and add the candidate account to the project. - After the candidate accepts the invitation, if the candidate does not have an apache email account, the voting initiator needs to assist the candidate to create an apache account according to the guidelines. - When signing the ICLA, the candidate needs to write the project name of “Apache Kvrocks” in the "notify project:" column, so that the candidate account will be added to the list of corresponding project personnel by Apache. - The voting initiator needs to add project team members, open a permission account for the apache project, and confirm that the candidate’s Apache account has been added to the project address: http://people.apache.org/phonebook.html?project=kvrocks. - -## ANNOUNCE to the community - After the above steps are completed, the vote initiator must send a notification email to the [email protected] mail group. The following is a sample notification email: - - ```shell - [ANNOUNCE] New [committer|pmc]: XXXXXX - - Hi everyone, - - The Project Management Committee(PMC) for Apache has invited XXXXXX to become a [committer|pmc] and we are pleased to announce that he has accepted. - - XXXXXX is being active in the Kvrocks community, and we are glad to see his more interactions with the community in the future. - - Welcome XXXXXX, and please enjoy your journey.:) - - Thanks! - - ``` - -At this point, the entire process is completed, and the candidate officially becomes the Committer or PMC of the project. - - diff --git a/community/index.md b/community/index.md index 75d13e5..9443821 100644 --- a/community/index.md +++ b/community/index.md @@ -1,5 +1,5 @@ --- -sidebar_position: 0 +id: community title: Community --- @@ -12,8 +12,6 @@ You can: * Report bugs and submit patches. * Contribute code, documentation. -Visit the [Contributing] page for more information. - ## Mailing list Get help using Kvrocks or contribute to the project on our mailing lists: @@ -26,7 +24,7 @@ Get help using Kvrocks or contribute to the project on our mailing lists: ### Bug Reports -Found bug? Enter an issue in the [Issue Tracker](https://github.com/apache/incubator-kvrocks/issues). +Found bug? Enter an issue in the [issue tracker](https://github.com/apache/incubator-kvrocks/issues). Before submitting an issue, please: @@ -34,9 +32,9 @@ Before submitting an issue, please: * Search the issue tracker to verify there is no existing issue reporting the bug you've found. * Consider tracking down the bug yourself in the source code of Kvrocks and submitting a patch along with your bug report. This is a great time saver for the Kvrocks developers and helps ensure the bug will be fixed quickly. -### Feature Requests +### Enhancement -Enhancement requests for new features are also welcome. The more concrete and rationale the request is, the greater the chance it will incorporated into future releases. +Enhancements or new feature proposals are also welcome. The more concrete and rationale the proposal is, the greater the chance it will be incorporated into future releases. ## Source Code diff --git a/community/vote-a-core-developer.md b/community/vote-a-core-developer.md new file mode 100644 index 0000000..59694d4 --- /dev/null +++ b/community/vote-a-core-developer.md @@ -0,0 +1,187 @@ +--- +id: vote-a-core-developer +title: How to vote a Committer or PMC Member +--- + +## Initiate discussion in the community private mailing group + +Any Kvrocks PMC member can initiate a voting discussion. + +After PMC finds any valuable contributions from community contributors and obtains the consent of the candidate, they can initiate a discussion on Kvrocks' private mailing list. + +In the discussion email, the proposer should clearly state the candidate's contributions and give the address for reviewing the corresponding contributions, so that everyone can discuss and analyze it. The discussion email is sent to `[email protected]`. The discussion will last at least 72 hours. PMC members will fully express their views on the proposed email. + +The following is a sample discussion email: + +```text +[DISCUSS] XXXXXX for Kvrocks [committer|PMC member] + +I nominate XXXXXX as an Kvrocks [committer|PMC member] + +Judging from the contributions in recent months, XXXXXX has submitted many +implementations[1][2] to the project and improved the management module for +the project. + +During the optimization and improvement period of the project, it is hoped that +more people will participate in the actual project optimization and improvement, +to let the project more perfect and easier to use. + +So I nominated XXXXXX as a [committer|PMC member] of the Kvrocks project. + +[1] https://github.com/apache/incubator-kvrocks/issues/created_by/XXXXXX +[2] https://github.com/apache/incubator-kvrocks/commits?author=XXXXXX +``` + +## Initiate vote in the community private mailing group + +If the discussion email does not receive the disagreement information within the specified time, the poll initiator needs to initiate a Committer or PMC election vote on Kvrocks' private mailing list. + +The voting email is sent to `[email protected]` for at least 72 hours, and at least 3 votes +1 passed; if less than 3 votes or 1 veto (-1 vote), the vote will fail; if a veto is initiated, the voter needs to EXPLAIN the reason for the veto clearly so that everyone can understand and know. A veto without explanation does not count. + +The following is a sample poll email: + +```text +[VOTE] XXXXXX as a Kvrocks [Committer|PMC member] + +Judging from contributions in recent months, XXXXXX has submitted many +implementations[1][2] to the project and improved the management module for +the project. + +During the optimization and improvement period of the project, it is hoped that +more people will participate in the actual project optimization and improvement, +to let the project more perfect and easier to use. + +I think making him/her a [committer|PMC member] will be a recognition of his/her +outstanding work for Kvrocks. So, I am happy to call VOTE to accept XXXXXX as a +Kvrocks [committer|PMC member] + + Voting will continue for at least 72 hours or until the required number of votes is reached. + + Please vote accordingly: + + [ ] +1 approve + [ ] +0 no opinion + [ ] -1 disapprove with the reason + +Here are three links to his contributions to Kvrocks: + +[1] Issues: https://github.com/apache/incubator-kvrocks/issues/created_by/XXXXXX +[2] PRs : https://github.com/apache/incubator-kvrocks/pulls/created_by/XXXXXX +``` + +## Feedback on voting results + +After the voting email is over, the initiator of the vote needs to remind the voting end in the second [VOTE] email; at the same time, the initiator of the vote needs to initiate a vote summary email, and the summary email is sent to `[email protected]`. + +The following is a sample vote summary email: + +```text +[RESULTS][VOTE] XXXXXX as a Kvrocks[committer|PMC member] + +Hi everyone, + +The vote for "XXXXXX as a Kvrocks [committer/PMC member]" has PASSED and closed now. + +The result is as follows: + +3 PMC members +1 Votes +- aaa +- bbb +- ccc + +Vote thread: https://lists.apache.org/thread/aaaaaxxxx + +Then I'm going to invite XXXXXX to join us. + +Thanks for everyone's support! +``` + +Note: If it is not passed, the result is "The vote for "XXXXXX as a Kvrocks [committer|PMC member]" has FAILED and closed now." + +## Newly added PMC member notification email + +This step is only processed for the PMC member that passed the vote. If the election is Committer, this step is skipped and not executed. + +Voting initiators need to send notification emails to Board's mailing group and wait at least 72 hours; email owners send `[email protected]` and CC `[email protected]`; Board will analyze compliance Until there is no doubt. + +The following is an example of a new PMC notification email: + +```text +[NOTICE] XXXXXX for Apache Kvrocks(incubating) PMC member + +Hi everyone, + +Apache Kvrocks(incubating) proposes to invite XXXXXX to join the PMC. + +The vote result is available here: https://lists.apache.org/... + +Thanks! +``` + +## Initiate invitation email + +After the result summary email is sent, the poll initiator must send an invitation email to the candidates. + +The invitation email is sent to the invitee with a CC to `[email protected]`; the invited candidate must reply to accept or decline the invitation through the specified email address. + +The following is an example of an email inviting candidates: + +```text +[Invitation] Invitation to join Apache Kvrocks as a [committer|PMC member] + +Hi XXXXXX, + +In recognition of your contributions to Apache Kvrocks(incubating), the Kvrocks PMC +has recently voted to add you as a [committer|PMC member]. The [committer|PMC member] +role gives you access to merge patches into Apache Kvrocks(incubating) and is also +a stepping-stone towards membership in the Project Management Committee (PMC). We hope +that you accept this invitation and continue to help us make Apache Kvrocks(incubating) +better. + +If you'd like to accept, you will need to send an Individual Contributor License Agreement +(ICLA) to [email protected], CCing [email protected], and request an +Apache account name as described at https://www.apache.org/dev/new-committers-guide.html +if you don't already have one, once you get an account name, or if you have one already, +please email it to me. + +NOTICE: when you fill out ICLA file, the value of preferred Apache id(s) needs to be a valid ID, +including: + + 1. The ID must not already be in use in https://people.apache.org/committer-index.html; + 2. The characters "-" and "_" are not allowed in id; + 3. The id must consist of lowercase alphanumeric characters only, + start with an alphabetic character, have a minimum length of 3 characters, + and have no special characters. + +With the expectation of your acceptance, welcome! + +The Apache Kvrocks(incubating) PMC +``` + +## Processing after accepting the invitation + +Create an Apache account and add the candidate account to the project. After the candidate accepts the invitation, if the candidate does not have an apache email account, the voting initiator needs to assist the candidate to create an Apache account according to the guidelines. + +When signing the ICLA, the candidate needs to write the project name of "Apache Kvrocks" in the "notify project:" column, so that the candidate account will be added to the list of corresponding project personnel by Apache. + +The voting initiator needs to add project team members, open a permission account for the Apache project, and confirm that the candidate's Apache account has been added to the project address: http://people.apache.org/phonebook.html?podling=kvrocks. + +## ANNOUNCE to the community + +After the above steps are completed, the vote initiator must send a notification email to the `[email protected]` mail group. The following is a sample notification email: + +```text +[ANNOUNCE] New [committer|PMC member]: XXXXXX + +Hi everyone, + +The Project Management Committee(PMC) for Apache Kvrocks has invited XXXXXX to become a [committer|PMC member] and we are pleased to announce that he has accepted. + +XXXXXX is being active in the Kvrocks community, and we are glad to see his more interactions with the community in the future. + +Welcome XXXXXX, and please enjoy your journey.:) + +Thanks! +``` + +At this point, the entire process is completed, and the candidate officially becomes a Committer or PMC member of the project. diff --git a/docusaurus.config.js b/docusaurus.config.js index ce6cd22..65a1093 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -32,7 +32,7 @@ const config = { id: 'community', path: 'community', routeBasePath: 'community', - sidebarPath: require.resolve('./sidebars.js'), + sidebarPath: require.resolve('./sidebarsCommunity.js'), }, ], [ @@ -41,7 +41,6 @@ const config = { id: 'download', path: 'download', routeBasePath: 'download', - sidebarPath: require.resolve('./sidebars.js'), }, ], ], diff --git a/sidebarsCommunity.js b/sidebarsCommunity.js new file mode 100644 index 0000000..edb101d --- /dev/null +++ b/sidebarsCommunity.js @@ -0,0 +1,25 @@ +/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */ +const sidebars = { + community: [ + 'community', + { + "type": "category", + "label": "Releases", + link: { + type: 'generated-index', + }, + }, + { + "type": "category", + "label": "Committers", + link: { + type: 'generated-index', + }, + items: [ + 'vote-a-core-developer', + ] + } + ], +}; + +module.exports = sidebars;
![http://github.com/Alfejik.png"/](https://github.com/Alfejik.png"/){kind=link}
![http://github.com/chenliang613.png"/](https://github.com/chenliang613.png"/){kind=link}
![http://github.com/git-hulk.png"/](https://github.com/git-hulk.png"/){kind=link}
![http://github.com/Hexiaoqiao.png"/](https://github.com/Hexiaoqiao.png"/){kind=link}
![http://github.com/jbonofre.png"/](https://github.com/jbonofre.png"/){kind=link}
![https://github.com/PragmaTwice.png"/](https://github.com/PragmaTwice.png"/){kind=link}
![https://github.com/ShooterIT.png"/](https://github.com/ShooterIT.png"/){kind=link}
![https://github.com/tisonkun.png"/](https://github.com/tisonkun.png"/){kind=link}
![https://github.com/vongosling.png"/](https://github.com/vongosling.png"/){kind=link}
![http://github.com/caipengbo.png"/](https://github.com/caipengbo.png"/){kind=link}
![http://github.com/ChrisZMF.png"/](https://github.com/ChrisZMF.png"/){kind=link}
![http://github.com/ColinChamber.png"/](https://github.com/ColinChamber.png"/){kind=link}
![http://github.com/jeanbone.png"/](https://github.com/jeanbone.png"/){kind=link}
![http://github.com/shangxiaoxiong.png"/](https://github.com/shangxiaoxiong.png"/){kind=link}
![http://github.com/smartlee.png"/](https://github.com/smartlee.png"/){kind=link}
![http://github.com/tanruixiang.png"/](https://github.com/tanruixiang.png"/){kind=link}
![http://github.com/torwig.png"/](https://github.com/torwig.png"/){kind=link}