Skip to content

Commit

Permalink
docs: Add process on nominating committers and ppmc members (#3740)
Browse files Browse the repository at this point in the history
* docs: Add process on nominating committers and ppmc members

Signed-off-by: Xuanwo <[email protected]>

* Remove typo

Signed-off-by: Xuanwo <[email protected]>

---------

Signed-off-by: Xuanwo <[email protected]>
  • Loading branch information
Xuanwo authored Dec 11, 2023
1 parent 11faa19 commit 6078c3f
Show file tree
Hide file tree
Showing 14 changed files with 365 additions and 43 deletions.
4 changes: 2 additions & 2 deletions website/community/committers/_category_.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,10 @@
# specific language governing permissions and limitations
# under the License.

position: 5
position: 3
label: 'Committers'
collapsible: true
collapsed: true
collapsed: false
link:
type: generated-index
title: Committers
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Committer onboarding
sidebar_position: 3
title: Onboarding
sidebar_position: 2
---

This document primarily serves as a guide for new committers to OpenDAL.
Expand Down
2 changes: 1 addition & 1 deletion website/community/committers/release.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Create a OpenDAL Release
sidebar_position: 1
sidebar_position: 3
---

This document mainly introduces
Expand Down
2 changes: 1 addition & 1 deletion website/community/committers/verify.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Verify a release candidate
sidebar_position: 2
sidebar_position: 4
---

To verify a release candidate, the following checklist could be used:
Expand Down
1 change: 1 addition & 0 deletions website/community/maturity.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Maturity
sidebar_position: 1
---

# Maturity Assessment for Apache OpenDAL
Expand Down
24 changes: 24 additions & 0 deletions website/community/ppmc_members/_category_.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you 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.

position: 4
label: 'PPMC Members'
collapsible: true
collapsed: false
link:
type: generated-index
title: Committers
150 changes: 150 additions & 0 deletions website/community/ppmc_members/nominate-committer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,150 @@
---
title: Nominate Committer
sidebar_position: 2
---

This document mainly introduces how the PPMC member nominate a new committer.

## Start vote about the candidate

Start a vote about the candidate via sending email to: <[email protected]>:

- candidate_name: The full name of the candidate.
- candidate_github_id: The github id of the candidate.

Title:

```
[VOTE] Add candidate ${candidate_name} as a new committer
```

Content:

```
Hi, All OpenDAL PPMC members.
I'd like to take this chance to call the vote for inviting committed
contributor ${candidate_name} (github id: ${candidate_github_id}) as a new committer of Apache
OpenDAL (incubating).
${candidate_contributions}
${candidate_name}'s great contributions could be found:
- Github Account: https://github.com/${candidate_github_id}
- Github Pull Requests: https://github.com/apache/incubator-opendal/pulls?q=is%3Apr+author%3A${candidate_github_id}+is%3Aclosed
- Github Issues: https://github.com/apache/incubator-opendal/issues?q=is%3Aopen+mentions%3A${candidate_github_id}
Please make your valuable evaluation on whether we could invite ${candidate_name} as a
committer:
[ +1 ] Agree to add ${candidate_name} as a committer of OpenDAL.
[ 0 ] Have no sense.
[ -1 ] Disagree to add ${candidate_name} as a committer of OpenDAL, because .....
This vote starts from the moment of sending and will be open for 3 days.
Thanks and best regards,
${your_name}
```

Example: <https://lists.apache.org/thread/j16lvkyrmvg8wyf3z4gqpjky5m594jhy> (Private Link)

After at least 3 `+1` binding vote and no veto, claim the vote result:

Title:

```
[RESULT][VOTE] Add candidate ${candidate_name} as a new committer
```

Content:

```
Hi, all:
The vote for "Add candidate ${candidate_name} as a new committer" has PASSED and closed now.
The result is as follows:
4 binding +1 Votes:
- voter names
Vote thread: https://lists.apache.org/thread/j16lvkyrmvg8wyf3z4gqpjky5m594jhy
Then I'm going to invite ${candidate_name} to join us.
Thanks for everyone's support!
${your_name}
```

## Send invitation to the candidate

Send an invitation to the candidate and cc <[email protected]>:

Title:

```
Invitation to become OpenDAL Committer: ${candidate_name}
```

Content:

```
Hello ${candidate_name},
The OpenDAL PPMC hereby offers you committer privileges
to the project. These privileges are offered on the
understanding that you'll use them reasonably and with
common sense. We like to work on trust rather than
unnecessary constraints.
Being a committer enables you to more easily make
changes without needing to go through the patch
submission process.
Being a committer does not require you to
participate any more than you already do. It does
tend to make one even more committed. You will
probably find that you spend more time here.
Of course, you can decline and instead remain as a
contributor, participating as you do now.
A. This personal invitation is a chance for you to
accept or decline in private. Either way, please
let us know in reply to the [[email protected]]
address only.
B. If you accept, the next step is to register an iCLA:
1. Details of the iCLA and the forms are found
through this link: https://www.apache.org/licenses/#clas
2. Instructions for its completion and return to
the Secretary of the ASF are found at
https://www.apache.org/licenses/#submitting
3. When you transmit the completed iCLA, request
to notify the Apache OpenDAL and choose a
unique Apache ID. Look to see if your preferred
ID is already taken at
https://people.apache.org/committer-index.html
This will allow the Secretary to notify the PPMC
when your iCLA has been recorded.
When recording of your iCLA is noted, you will
receive a follow-up message with the next steps for
establishing you as a committer.
With the expectation of your acceptance, welcome!
${your_name} (as represents of The Apache OpenDAL(incubating) PPMC)
```

## Add the candidate to the committer list

After the candidate accepts the invitation and the iCLA is recorded, add the candidate to the committer list by [whimsy roster tools](https://whimsy.apache.org/roster/ppmc/opendal)

![](roster-add-committer.png)
127 changes: 127 additions & 0 deletions website/community/ppmc_members/nominate-ppmc-member.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,127 @@
---
title: Nominate PPMC Member
sidebar_position: 3
---

This document mainly introduces how the PPMC member nominate a new PPMC member.

## Start vote about the candidate

Start a vote about the candidate via sending email to: <[email protected]>:

- candidate_name: The full name of the candidate.
- candidate_github_id: The github id of the candidate.

Title:

```
[VOTE] Add candidate ${candidate_name} as a new PPMC member
```

Content:

```
Hi, All OpenDAL PPMC members.
I would like to nominate ${candidate_name} (github id: ${candidate_github_id}) as a candidate for the OpenDAL PPMC member. Since becoming an OpenDAL committer, Xiangdong has made significant contributions to various modules of the project.
${candidate_contributions}
${candidate_name}'s great contributions could be found:
- Github Account: https://github.com/${candidate_github_id}
- Github Pull Requests: https://github.com/apache/incubator-opendal/pulls?q=is%3Apr+author%3A${candidate_github_id}+is%3Aclosed
- Github Issues: https://github.com/apache/incubator-opendal/issues?q=is%3Aopen+mentions%3A${candidate_github_id}
Please make your valuable evaluation on whether we could invite ${candidate_name} as a
committer:
[ +1 ] Agree to add ${candidate_name} as a PPMC member of OpenDAL.
[ 0 ] Have no sense.
[ -1 ] Disagree to add ${candidate_name} as a PPMC member of OpenDAL, because .....
This vote starts from the moment of sending and will be open for 3 days.
Thanks and best regards,
${your_name}
```

Example: <https://lists.apache.org/thread/yg2gz2tof3cvbrgp1wxzk6mf9o858h7t> (Private Link)

After at least 3 `+1` binding vote and no veto, claim the vote result:

Title:

```
[RESULT][VOTE] Add candidate ${candidate_name} as a new PPMC member
```

Content:

```
Hi, all:
The vote for "Add candidate ${candidate_name} as a new PPMC member" has PASSED and closed now.
The result is as follows:
4 binding +1 Votes:
- voter names
Vote thread: https://lists.apache.org/thread/yg2gz2tof3cvbrgp1wxzk6mf9o858h7t
Then I'm going to invite ${candidate_name} to join us.
Thanks for everyone's support!
${your_name}
```

## Send NOTICE to IPMC after VOTE PASSED

The nominating PPMC member should send a message to the IPMC <[email protected]> with a reference to the vote result in the following form:

Title:

```
[NOTICE] ${candidate_name} for OpenDAL PPMC
```

Content:

```
${candidate_name} has been voted as a new member of the OpenDAL PPMC. the vote thread is at:
https://lists.apache.org/thread/yg2gz2tof3cvbrgp1wxzk6mf9o858h7t
```

## Send invitation to the candidate

Send an invitation to the candidate and cc <[email protected]>:

Title:

```
Invitation to become OpenDAL PPMC Member: ${candidate_name}
```

Content:

```
Hello ${candidate_name},
In recognition of your contributions to Apache OpenDAL(incubating), the OpenDAL PPMC has recently voted to add you as a PPMC member. The role of a PPMC member grants you access to the Podling Project Management Committee (PPMC) and enables you to take on greater responsibilities within the OpenDAL project. We hope that you accept this invitation and continue to help us make Apache OpenDAL(incubating) better.
Please reply to [email protected] using the 'reply all' function for your responses.
With the expectation of your acceptance, welcome!
${your_name} (as represents of The Apache OpenDAL(incubating) PPMC)
```

## Add the candidate to the PPMC member list

After the candidate accepts the invitation, add the candidate to the PPMC member list by [whimsy roster tools](https://whimsy.apache.org/roster/ppmc/opendal)

![](roster-add-ppmc-member.png)
19 changes: 19 additions & 0 deletions website/community/ppmc_members/onboarding.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
title: Onboarding
sidebar_position: 1
---

This document primarily serves as a guide for new PPMC members to OpenDAL.

Upon receiving an invitation email from OpenDAL's PPMC, a new PPMC member should consider whether accepting.
If they decide in favor, they should select "Reply All" and express their decision.

### Subscribe to Private Mailing List

1. Send email to [[email protected]](mailto:[email protected])
2. You will receive an email with the subject "confirm subscribe to [email protected]"
3. Reply to the email with "Confirm" in the body

If you receive an email with the subject "WELCOME to [email protected]", you have successfully subscribed to the private mailing list.

It's required for PPMC members to subscribe the private mailing list. The private list is only for confidential discussions that should not be made public, such as the suitability of a particular individual to become a committer or a member of the PPMC.
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Podling status reports
title: Podling Status Reports
sidebar_position: 4
---

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions website/community/security.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Security
sidebar_position: 2
---

# Security
Expand Down
Loading

0 comments on commit 6078c3f

Please sign in to comment.