This is an automated email from the ASF dual-hosted git repository. jiayu pushed a commit to branch community-doc-update in repository https://gitbox.apache.org/repos/asf/sedona.git
commit 9f6395fd816d82b9d19334fd4c2dad0641a0db9f Author: Jia Yu <[email protected]> AuthorDate: Mon Mar 10 17:13:04 2025 -0700 Update the community docs --- .github/pull_request_template.md | 8 ++++---- docs/community/contact.md | 38 ++++++++++++++++++-------------------- docs/community/rule.md | 6 +++--- 3 files changed, 25 insertions(+), 27 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 7598bd0197..88d6d14a46 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,18 +1,18 @@ ## Did you read the Contributor Guide? -- Yes, I have read the [Contributor Rules](https://sedona.apache.org/latest-snapshot/community/rule/) and [Contributor Development Guide](https://sedona.apache.org/latest-snapshot/community/develop/) +- Yes, I have read the [Contributor Rules](https://sedona.apache.org/latest/community/rule/) and [Contributor Development Guide](https://sedona.apache.org/latest/community/develop/) - No, I haven't read it. -## Is this PR related to a JIRA ticket? +## Is this PR related to a ticket? -- Yes, the URL of the associated JIRA ticket is https://issues.apache.org/jira/browse/SEDONA-XXX. The PR name follows the format `[SEDONA-XXX] my subject`. +- Yes, and the PR name follows the format `[SEDONA-XXX] my subject`. +- Yes, and the PR name follows the format `[GH-XXX] my subject`. - No: - this is a documentation update. The PR name follows the format `[DOCS] my subject` - this is a CI update. The PR name follows the format `[CI] my subject` - ## What changes were proposed in this PR? diff --git a/docs/community/contact.md b/docs/community/contact.md index fee2a2bae6..8268c2e089 100644 --- a/docs/community/contact.md +++ b/docs/community/contact.md @@ -30,38 +30,36 @@ You can participate in the community as follows: ## Community events -Everyone is welcome to join our community events. We have a community office hour every 4 weeks. Please import the event to your [Google Calendar](https://calendar.google.com/calendar/event?action=TEMPLATE&tmeid=NjI0cWgwcTZndnI1anAzYnFrNHY5Y2wyaTRfMjAyNDA0MDlUMTUwMDAwWiBjX2VmN2Q1NGY1MzA4YTRiN2YyNWFjMzNkMGY3ZWViNTRhM2E3ZjExNWI2ODlmYWY0ZDgyNDI1ZjNjYjVlZGU5MzVAZw&tmsrc=c_ef7d54f5308a4b7f25ac33d0f7eeb54a3a7f115b689faf4d82425f3cb5ede935%40group.calendar.google.com&scp=ALL). +Everyone is welcome to join our community events. We have a community office hour every 4 weeks. Please register to the event you want to attend: https://bit.ly/3UBmxFY -## Twitter +## Sedona on LinkedIn -[Apache Sedona@Twitter](https://twitter.com/ApacheSedona) +[Apache Sedona@LinkedIn](https://www.linkedin.com/company/apache-sedona) -## Discord Server - -[](https://share.hsforms.com/1Ndql_ZigTdmLlVQc_d1o4gqga4q) - -## Mailing list - -Get help using Sedona or contribute to the project on our mailing lists - -[Sedona Mailing Lists](https://lists.apache.org/list.html?sedona.apache.org): [[email protected]](https://lists.apache.org/[email protected]): project development and general questions +## Sedona on X -* Please first subscribe and then post emails. To subscribe, please send an email (leave the subject and content blank) to [email protected] +[Apache Sedona@X](https://X.com/ApacheSedona) -## Issue tracker +## Discord Server -### Bug Reports +[](https://share.hsforms.com/1Ndql_ZigTdmLlVQc_d1o4gqga4q) -Found bug? Enter an issue in the [Sedona JIRA](https://issues.apache.org/jira/projects/SEDONA) +## Get help -Before submitting an issue, please: +You can ask for help or contribute to the project. Before submitting an issue, please: * Verify that the bug does in fact exist. * 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 Sedona’s source and submitting a patch along with your bug report. This is a great time saver for the Sedona developers and helps ensure the bug will be fixed quickly. -### Feature Requests - Enhancement requests for new features are also welcome. The more concrete and rationale the request is, the greater the chance it will be incorporated into future releases. -Enter an issue in the [Sedona JIRA](https://issues.apache.org/jira/projects/SEDONA) or email to [[email protected]](https://lists.apache.org/[email protected]) +* [Sedona JIRA](https://issues.apache.org/jira/projects/SEDONA): bug reports and feature requests +* [Sedona Github Issues](https://github.com/apache/sedona/issues?q=sort%3Aupdated-desc+is%3Aissue+is%3Aopen): bug reports and feature requests +* [Sedona GitHub Discussion](https://github.com/apache/sedona/discussions): project development and general questions +* [Sedona Mailing Lists](https://lists.apache.org/list.html?sedona.apache.org): [[email protected]](https://lists.apache.org/[email protected]): project development and general questions. + +For the mailing list, Please first subscribe and then post emails. To subscribe, please send an email (leave the subject and content blank) to [[email protected]](mailto:[email protected]?subject=Subscribe&body=Subscribe) + +!!!tip + All serious conversation such as voting will only take place on the mailing list. This includes voting on each release candidate or major change to the project. Please pay attention to the mailing list! diff --git a/docs/community/rule.md b/docs/community/rule.md index b3dd2a4020..cdeaeaf684 100644 --- a/docs/community/rule.md +++ b/docs/community/rule.md @@ -23,9 +23,9 @@ The project welcomes contributions. You can contribute to Sedona code or documen The following sections brief the workflow of how to complete a contribution. -## Pick / Announce a task using JIRA +## Pick / Announce a task -It is important to confirm that your contribution is acceptable. You should create a JIRA ticket or pick an existing ticket. A new JIRA ticket will be automatically sent to `[email protected]` +It is important to confirm that your contribution is acceptable. Before starting a contribution, you should announce your intention to the community via tickets. Sedona allows tickets from both [GitHub issues](https://github.com/apache/sedona/issues?q=sort%3Aupdated-desc+is%3Aissue+is%3Aopen) and [JIRA](https://issues.apache.org/jira/projects/SEDONA). A new JIRA ticket will be automatically sent to `[email protected]` ## Develop a code contribution @@ -54,7 +54,7 @@ Documentation contributions should satisfy the following requirements: After developing a contribution, the easiest and most visible way to submit a Pull Request (PR) to the [GitHub repo](https://github.com/apache/sedona). -**Please use the JIRA ticket ID in the PR name, such as "[SEDONA-1] my subject".** +**Please use the JIRA ticket ID or GitHub Issue ID in the PR name, such as "[SEDONA-1] my subject" or ""[GH-1] my subject".** When creating a PR, please answer the questions in the PR template.
