You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sedona.apache.org by ji...@apache.org on 2022/06/06 07:43:27 UTC
[incubator-sedona] branch master updated: [DOCS] Update the decision-making process
This is an automated email from the ASF dual-hosted git repository.
jiayu pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-sedona.git
The following commit(s) were added to refs/heads/master by this push:
new 56d73fd7 [DOCS] Update the decision-making process
56d73fd7 is described below
commit 56d73fd7bc9998390028b6d10b97a839ea21f819
Author: Jia Yu <ji...@apache.org>
AuthorDate: Mon Jun 6 00:43:19 2022 -0700
[DOCS] Update the decision-making process
---
docs/community/contributor.md | 64 +++++++++++++++++++++++++++++++++++++++++++
docs/community/publish.md | 25 +++++++++++------
docs/community/rule.md | 16 ++++++++++-
docs/community/vote.md | 28 +++++++++----------
4 files changed, 109 insertions(+), 24 deletions(-)
diff --git a/docs/community/contributor.md b/docs/community/contributor.md
index 86a441c2..d4686935 100644
--- a/docs/community/contributor.md
+++ b/docs/community/contributor.md
@@ -32,3 +32,67 @@ Mentors from Apache Incubator help the project to turn into a good shape followi
| Von Gosling| vongosling@apache.org |
|Jean-Baptiste Onofré| jbonofre@apache.org |
| George Percivall | percivall@apache.org |
+
+## Become a committer
+
+To get started contributing to Sedona, learn [how to contribute](../rule) – anyone can submit patches, documentation and examples to the project.
+
+The PMC regularly adds new committers from the active contributors, based on their contributions to Sedona. The qualifications for new committers include:
+
+* Sustained contributions to Spark: Committers should have a history of major contributions to Sedona.
+* Quality of contributions: Committers more than any other community member should submit simple, well-tested, and well-designed patches. In addition, they should show sufficient expertise to be able to review patches.
+* Community involvement: Committers should have a constructive and friendly attitude in all community interactions. They should also be active on the dev mailing list & Gitter, and help mentor newer contributors and users.
+
+The PMC also adds new PMC members. PMC members are expected to carry out PMC responsibilities as described in Apache Guidance, including helping vote on releases, enforce Apache project trademarks, take responsibility for legal and license issues, and ensure the project follows Apache project mechanics. The PMC periodically adds committers to the PMC who have shown they understand and can help with these activities.
+
+Currently, Sedona makes committers PMC members automatically.
+
+## Nominate a committer or PMC member
+
+Steps are as follows:
+1. Call a vote (templates/committerVote.txt)
+2. Close the vote. If the result is positive, invite the new committer.
+
+### Call for a vote
+We do the vote and discussion on the private@sedona.apache.org to enable a frank discussion. Please read [ASF New committer Discussion](https://community.apache.org/newcommitter.html#discussion) for notable items.
+
+Let the Vote thread run for one week. A positive result is achieved by Consensus Approval: at least 3 +1 votes and no vetoes.
+
+#### PMC vote template
+
+This is the email to commence a vote for a new PMC candidate. New PMC members need to be voted for by the existing PMC members and subsequently approved by the Board (or Incubator PMC for incubating projects).
+
+```
+To: private@sedona.apache.org
+Subject: [VOTE] New PMC candidate: [New PMC NAME]
+
+[ add the reasons behind your nomination here ]
+
+Voting ends one week from today, or until at least 3 +1 votes are cast.
+
+See voting guidelines at
+https://community.apache.org/newcommitter.html
+```
+
+### Close a vote
+
+This email ends the vote and reports the result to the project.
+
+```
+To: private@sedona.apache.org
+Subject: [RESULT] [VOTE] New committer (or PMC candidate): [New PMC NAME]
+
+The vote has now closed. The results are:
+
+Binding Votes:
+
++1 [TOTAL BINDING +1 VOTES]
+ 0 [TOTAL BINDING +0/-0 VOTES]
+-1 [TOTAL BINDING -1 VOTES]
+
+The vote is ***successful/not successful***
+```
+
+### Next steps
+
+Next steps include board approval, PMC invite, and PMC account set up. Please read [ASF New Committer](https://community.apache.org/newcommitter.html#board-approval-of-new-pmc-member).
diff --git a/docs/community/publish.md b/docs/community/publish.md
index fa72b066..fc0cdb61 100644
--- a/docs/community/publish.md
+++ b/docs/community/publish.md
@@ -9,7 +9,7 @@ This page is for Sedona PPMC to publish Sedona releases.
3. Merge your Apache and GitHub accounts using GitBox (Apache Account Linking utility): https://gitbox.apache.org/setup/
* You should see 3 green checks in GitBox
* Wait at least 30 minutes for an email inviting you to Apache GitHub Organization and accept invitation
-4. After accepting the Github Invitation verify that you are a member of the team https://github.com/orgs/apache/teams/openwhisk-committers
+4. After accepting the Github Invitation, verify that you are a member of the team https://github.com/orgs/apache/teams/sedona-committers
5. Additionally, if you have been elected to the Sedona PPMC, verify you are part of the LDAP Sedona PPMC https://whimsy.apache.org/roster/ppmc/sedona
## Prepare Secret GPG key
@@ -100,6 +100,10 @@ rm report.txt
## Publish releases
+### Update mkdocs.yml
+
+Please change the `sedona.current_version`, `sedona.current_rc`, `sedona.current_git_tag` and `sedona.current_snapshot` in `mkdocs.yml` to the version you want to publish. Do NOT change `sedona.next_version` at this moment. Then compile the website by `mkdocs serve`. This will generate the scripts listed on this page in your local browser.
+
### Update Sedona Python, R and Zeppelin versions
Make sure the Sedona version in the following files are {{ sedona.current_version }}. Note that: Python and R versions cannot have "incubating" postfix.
@@ -203,6 +207,7 @@ rm -rf apache-sedona-{{ sedona.current_version }}-bin
1. Check the status of the staging repo: [Locate and Examine Your Staging Repository
](https://central.sonatype.org/pages/releasing-the-deployment.html#locate-and-examine-your-staging-repository). You should see 12 Sedona modules in total.
2. Call for a vote in Sedona community and Apache incubator. Then close the staging repo.
+3. The vote will be open for at least 72 hours or until at least 3 "+1" PMC votes are cast
Here is a generated vote email. Please add changes at the end if needed:
@@ -228,7 +233,7 @@ https://downloads.apache.org/incubator/sedona/KEYS
Source code and binaries:
https://dist.apache.org/repos/dist/dev/incubator/sedona/{{ sedona.current_rc }}/
-The vote will be open for at least 72 hours or until a majority of at least 3 "approve" PMC votes are cast
+The vote will be open for at least 72 hours or until at least 3 "+1" PMC votes are cast
Please vote accordingly:
@@ -281,7 +286,9 @@ approval by the IPMC. If this vote passes too, the release is accepted and will
### Vote in general incubator.apache.org
-Here is a generated vote email. Please add changes at the end if needed:
+Here is a generated vote email. Please add changes at the end if needed.
+
+The vote will be open for at least 72 hours or until at least 3 "+1" PMC votes are cast.
```
Subject: [VOTE] Release Apache Sedona {{ sedona.current_rc }}
@@ -309,7 +316,7 @@ https://downloads.apache.org/incubator/sedona/KEYS
Source code and binaries:
https://dist.apache.org/repos/dist/dev/incubator/sedona/{{ sedona.current_rc }}/
-The vote will be open for at least 72 hours or until a majority of at least 3 "approve" PMC votes are cast
+The vote will be open for at least 72 hours or until at least 3 "+1" PMC votes are cast
Please vote accordingly:
@@ -567,11 +574,11 @@ admin is your Apache ID username and admin123 is your Apache ID password. You ca
Once the staging repo is closed, click "Release" on the web interface.
## Publish the doc website
-
-1. Run `mkdocs build` in Sedona root directory. Copy all content in the `site` folder.
-2. Check out GitHub incubator-sedona-website [asf-site branch](https://github.com/apache/incubator-sedona-website/tree/asf-site)
-3. Use the copied content to replace all content in `asf-site` branch and upload to GitHub. Then `sedona.apache.org` will be automatically updated.
-4. You can also push the content to `asf-staging` branch. The staging website will be then updated: `sedona.staged.apache.org`
+1. Update `sedona.next_version` in `mkdocs.yml` to the next version. Note that: the next version means the version after the version you want to release.
+2. Run `mkdocs build` in Sedona root directory. Copy all content in the `site` folder.
+3. Check out GitHub incubator-sedona-website [asf-site branch](https://github.com/apache/incubator-sedona-website/tree/asf-site)
+4. Use the copied content to replace all content in `asf-site` branch and upload to GitHub. Then `sedona.apache.org` will be automatically updated.
+5. You can also push the content to `asf-staging` branch. The staging website will be then updated: `sedona.staged.apache.org`
### Javadoc and Scaladoc
diff --git a/docs/community/rule.md b/docs/community/rule.md
index 16a4adfd..88d67f24 100644
--- a/docs/community/rule.md
+++ b/docs/community/rule.md
@@ -39,4 +39,18 @@ After developing a contribution, the easiest and most visible way to submit a Pu
When creating a PR, please answser the questions in the PR template.
-When a PR is submitted, GitHub Action will check the build correctness. Please check the PR status, and fix any reported problems.
\ No newline at end of file
+When a PR is submitted, GitHub Action will check the build correctness. Please check the PR status, and fix any reported problems.
+
+## Review a Pull Request
+
+* Every PR requires (1) at least 1 approval from a committer and (2) no disapproval from a committer. Everyone is welcome to review a PR but only the committer can make the final decision.
+* Other reviewers, including community members and committers, may comment on the changes and suggest modifications. Changes can be added by simply pushing more commits to the same branch.
+* Lively, polite, rapid technical debate is encouraged from everyone in the community even if the outcome may be a rejection of the entire change.
+* Keep in mind that changes to more critical parts of Sedona, like Sedona core and spatial join algorithms, will be subjected to more review, and may require more testing and proof of its correctness than other changes.
+* Sometimes, other changes will be merged which conflict with your pull request’s changes. The PR can’t be merged until the conflict is resolved. This can be resolved by resolving the conflicts by hand, then pushing the result to your branch.
+
+## Code of Conduct
+
+Please read [Apache Software Foundation Code of Conduct](https://www.apache.org/foundation/policies/conduct.html).
+
+We expect everyone who participates in the Apache community formally or informally, or claims any affiliation with the Foundation, in any Foundation-related activities and especially when representing the ASF in any role to honor this code of conduct.
\ No newline at end of file
diff --git a/docs/community/vote.md b/docs/community/vote.md
index 0a8aea4e..97f0ee6f 100644
--- a/docs/community/vote.md
+++ b/docs/community/vote.md
@@ -27,12 +27,12 @@ You can skip this step if you installed these software before.
```bash
#!/bin/bash
wget https://downloads.apache.org/incubator/sedona/KEYS
-wget https://dist.apache.org/repos/dist/dev/incubator/sedona/{{ sedona.current_rc }}/apache-sedona-{{ sedona.current_version }}-src.tar.gz
-wget https://dist.apache.org/repos/dist/dev/incubator/sedona/{{ sedona.current_rc }}/apache-sedona-{{ sedona.current_version }}-src.tar.gz.asc
-wget https://dist.apache.org/repos/dist/dev/incubator/sedona/{{ sedona.current_rc }}/apache-sedona-{{ sedona.current_version }}-src.tar.gz.sha512
-wget https://dist.apache.org/repos/dist/dev/incubator/sedona/{{ sedona.current_rc }}/apache-sedona-{{ sedona.current_version }}-bin.tar.gz
-wget https://dist.apache.org/repos/dist/dev/incubator/sedona/{{ sedona.current_rc }}/apache-sedona-{{ sedona.current_version }}-bin.tar.gz.asc
-wget https://dist.apache.org/repos/dist/dev/incubator/sedona/{{ sedona.current_rc }}/apache-sedona-{{ sedona.current_version }}-bin.tar.gz.sha512
+wget https://dist.apache.org/repos/dist/dev/incubator/sedona/{{ sedona.current_rc }}/apache-sedona-{{ sedona.next_version }}-src.tar.gz
+wget https://dist.apache.org/repos/dist/dev/incubator/sedona/{{ sedona.current_rc }}/apache-sedona-{{ sedona.next_version }}-src.tar.gz.asc
+wget https://dist.apache.org/repos/dist/dev/incubator/sedona/{{ sedona.current_rc }}/apache-sedona-{{ sedona.next_version }}-src.tar.gz.sha512
+wget https://dist.apache.org/repos/dist/dev/incubator/sedona/{{ sedona.current_rc }}/apache-sedona-{{ sedona.next_version }}-bin.tar.gz
+wget https://dist.apache.org/repos/dist/dev/incubator/sedona/{{ sedona.current_rc }}/apache-sedona-{{ sedona.next_version }}-bin.tar.gz.asc
+wget https://dist.apache.org/repos/dist/dev/incubator/sedona/{{ sedona.current_rc }}/apache-sedona-{{ sedona.next_version }}-bin.tar.gz.sha512
```
## Verify the signature and checksum
@@ -40,12 +40,12 @@ wget https://dist.apache.org/repos/dist/dev/incubator/sedona/{{ sedona.current_r
```bash
#!/bin/bash
gpg --import KEYS.txt
-gpg --verify apache-sedona-{{ sedona.current_version }}-src.tar.gz.asc
-gpg --verify apache-sedona-{{ sedona.current_version }}-bin.tar.gz.asc
-shasum -a 512 apache-sedona-{{ sedona.current_version }}-src.tar.gz
-cat apache-sedona-{{ sedona.current_version }}-src.tar.gz.sha512
-shasum -a 512 apache-sedona-{{ sedona.current_version }}-bin.tar.gz
-cat apache-sedona-{{ sedona.current_version }}-bin.tar.gz.sha512
+gpg --verify apache-sedona-{{ sedona.next_version }}-src.tar.gz.asc
+gpg --verify apache-sedona-{{ sedona.next_version }}-bin.tar.gz.asc
+shasum -a 512 apache-sedona-{{ sedona.next_version }}-src.tar.gz
+cat apache-sedona-{{ sedona.next_version }}-src.tar.gz.sha512
+shasum -a 512 apache-sedona-{{ sedona.next_version }}-bin.tar.gz
+cat apache-sedona-{{ sedona.next_version }}-bin.tar.gz.sha512
```
If successful, you should be able to see something similar to the following text. It should include `Good signature from` and the final 4 lines should be two pairs of checksum matching each other.
@@ -79,9 +79,9 @@ d3bdfd4d870838ebe63f21cb93634d2421ec1ac1b8184636206a5dc0d89a78a88257798b1f17371a
## Check files manually
-1. Check if the downloaded files have the correct version: `{{ sedona.current_version }}`
+1. Check if the downloaded files have the correct version: `{{ sedona.next_version }}`
-2. Unzip the downloaded `apache-sedona-{{ sedona.current_version }}-src.tar.gz` file, and check if DISCLAIMER and NOTICE files and included and up to date.
+2. Unzip the downloaded `apache-sedona-{{ sedona.next_version }}-src.tar.gz` file, and check if DISCLAIMER and NOTICE files and included and up to date.
## Compile the project from source