From 11333c0b4d3a4962b0a6610ceb5b6d7a12e45ec4 Mon Sep 17 00:00:00 2001 From: Dianjin Wang Date: Fri, 1 Nov 2024 15:23:26 +0800 Subject: [PATCH] Doc: update basic community files for ASF In this commit, basic community files are udpated to follow the Apache rules and requests, including CoC, Security policy, and other places for a good project name. --- .asf.yaml | 4 +- .github/DISCUSSION_TEMPLATE/proposal.yml | 4 +- .github/ISSUE_TEMPLATE/bug-report.yml | 8 +- .github/ISSUE_TEMPLATE/config.yml | 14 +- .github/full_color_black.svg | 39 +++++- .github/full_color_white.svg | 39 +++++- .github/pull_request_template.md | 4 +- .gitmessage | 4 +- CODE_OF_CONDUCT.md | 135 +------------------- CONTRIBUTING.md | 102 +++++++-------- README.md | 156 ++++++++++------------- SECURITY.md | 68 +--------- 12 files changed, 223 insertions(+), 354 deletions(-) diff --git a/.asf.yaml b/.asf.yaml index 6054d1417ba..04618bee512 100644 --- a/.asf.yaml +++ b/.asf.yaml @@ -129,7 +129,7 @@ notifications: issues: commits@cloudberry.apache.org # Route pull request notifications to commits mailing list pullrequests: commits@cloudberry.apache.org - # Route discussion notifications to commits mailing list - discussions: commits@cloudberry.apache.org + # Route discussion notifications to dev mailing list + discussions: dev@cloudberry.apache.org # Route dependabot pull request notifications to private mailing list pullrequests_bot_dependabot: private@cloudberry.apache.org diff --git a/.github/DISCUSSION_TEMPLATE/proposal.yml b/.github/DISCUSSION_TEMPLATE/proposal.yml index bee7585e10d..25cf78dbb0f 100644 --- a/.github/DISCUSSION_TEMPLATE/proposal.yml +++ b/.github/DISCUSSION_TEMPLATE/proposal.yml @@ -5,11 +5,11 @@ body: attributes: value: " - Thanks for proposing major changes to Cloudberry Database! + Thanks for proposing major changes to Apache Cloudberry! When changes are just minor updates, general bug fixes, just Pull Request directly! - When you just have one idea or more `casual` feature request, consider choosing [Ideas / Feature Requests](https://github.com/apache/cloudberrydb/discussions/new?category=ideas-feature-requests). + When you just have one idea or more `casual` feature request, consider choosing [Ideas / Feature Requests](https://github.com/apache/cloudberry/discussions/new?category=ideas-feature-requests). But any of the following can be considered a major change that needs to have **Proposal**. diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index 732cc92a266..7b310ad360e 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -1,14 +1,14 @@ name: "\U0001F41B Bug Report" -description: Problems and issues with code in Cloudberry Database core. +description: Problems and issues with code in Apache Cloudberry core. title: "[Bug] " labels: ["type: Bug"] body: - type: markdown attributes: - value: "Thank you for reporting the problem! We really appreciate your efforts to improve Cloudberry Database. Before reporting it, please (ideally) test on the latest release or main to see if the issue is fixed." + value: "Thank you for reporting the problem! We really appreciate your efforts to improve Apache Cloudberry. Before reporting it, please (ideally) test on the latest release or main to see if the issue is fixed." - type: textarea attributes: - label: Cloudberry Database version + label: Apache Cloudberry version description: What version are you using? - type: textarea attributes: @@ -60,7 +60,7 @@ body: options: - label: > I agree to follow this project's - [Code of Conduct](https://cloudberrydb.org/community/coc). + [Code of Conduct](https://github.com/apache/cloudberry/blob/main/CODE_OF_CONDUCT.md). required: true - type: markdown attributes: diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 7b889c42b76..26171e9e9b8 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,17 +1,17 @@ blank_issues_enabled: false contact_links: - name: 🙏🏻 Q&A - url: https://github.com/apache/cloudberrydb/discussions/categories/q-a - about: Ask for help when running/developing Cloudberry Database. + url: https://github.com/apache/cloudberry/discussions/categories/q-a + about: Ask for help when running/developing Apache Cloudberry. - name: 💡️ New Ideas / Feature Requests - url: https://github.com/apache/cloudberrydb/discussions/categories/ideas-feature-requests + url: https://github.com/apache/cloudberry/discussions/categories/ideas-feature-requests about: Share ideas for new features. - name: 🎙️ Submit Your Proposal - url: https://github.com/apache/cloudberrydb/discussions/categories/proposal - about: As a developer, proposing any major change or enhancement to Cloudberry Database. + url: https://github.com/apache/cloudberry/discussions/categories/proposal + about: As a developer, proposing any major change or enhancement to Apache Cloudberry. - name: 💬️ Join Slack for Real-time Chat - url: https://communityinviter.com/apps/cloudberrydb/welcome + url: https://inviter.co/apache-cloudberry about: Real-time chat including QA, Dev, Events and more. - name: 🪲 Issues for Website, Docs - url: https://github.com/cloudberrydb/cloudberrydb-site/issues + url: https://github.com/apache/cloudberry-site/issues about: Hey, we have one dedicated repo for the website and docs. diff --git a/.github/full_color_black.svg b/.github/full_color_black.svg index e0cec6febc6..6fd299516f6 100644 --- a/.github/full_color_black.svg +++ b/.github/full_color_black.svg @@ -1 +1,38 @@ - \ No newline at end of file + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/.github/full_color_white.svg b/.github/full_color_white.svg index 2f67b987d5d..39d49edc6f2 100644 --- a/.github/full_color_white.svg +++ b/.github/full_color_white.svg @@ -1 +1,38 @@ - \ No newline at end of file + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index bfc25d0ffc0..f8a0f848232 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,4 +1,4 @@ - + Fixes #ISSUE_Number @@ -46,4 +46,4 @@ Fixes #ISSUE_Number --- +- Discussions: https://github.com/apache/cloudberry/discussions --> \ No newline at end of file diff --git a/.gitmessage b/.gitmessage index 93ab5e07142..9852789f9a9 100644 --- a/.gitmessage +++ b/.gitmessage @@ -33,8 +33,8 @@ Add your commit body here #on-behalf-of: @ORG NAME@ORGANIZATION.COM # If your commit have clear context included in GitHub Issues or GitHub # Discussions, please list them as a reference: -#See: Issue#id ? -#See: Discussion#id ? +#See: Issue#id ? +#See: Discussion#id ? ######################################################################## # # diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 922d7f5069e..fba27afa81c 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -1,131 +1,8 @@ -# Contributor Covenant Code of Conduct +# Code of Conduct -## Our Pledge +Apache Cloudberry (Incubating) follows the ASF [Code of +Conduct](https://www.apache.org/foundation/policies/conduct). -We as members, contributors, and leaders pledge to make participation in our -community a harassment-free experience for everyone, regardless of age, body -size, visible or invisible disability, ethnicity, sex characteristics, gender -identity and expression, level of experience, education, socio-economic status, -nationality, personal appearance, race, caste, color, religion, or sexual -identity and orientation. - -We pledge to act and interact in ways that contribute to an open, welcoming, -diverse, inclusive, and healthy community. - -## Our Standards - -Examples of behavior that contributes to a positive environment for our -community include: - -* Demonstrating empathy and kindness toward other people -* Being respectful of differing opinions, viewpoints, and experiences -* Giving and gracefully accepting constructive feedback -* Accepting responsibility and apologizing to those affected by our mistakes, - and learning from the experience -* Focusing on what is best not just for us as individuals, but for the overall - community - -Examples of unacceptable behavior include: - -* The use of sexualized language or imagery, and sexual attention or advances of - any kind -* Trolling, insulting or derogatory comments, and personal or political attacks -* Public or private harassment -* Publishing others' private information, such as a physical or email address, - without their explicit permission -* Other conduct which could reasonably be considered inappropriate in a - professional setting - -## Enforcement Responsibilities - -Community leaders are responsible for clarifying and enforcing our standards of -acceptable behavior and will take appropriate and fair corrective action in -response to any behavior that they deem inappropriate, threatening, offensive, -or harmful. - -Community leaders have the right and responsibility to remove, edit, or reject -comments, commits, code, wiki edits, issues, and other contributions that are -not aligned to this Code of Conduct, and will communicate reasons for moderation -decisions when appropriate. - -## Scope - -This Code of Conduct applies within all community spaces, and also applies when -an individual is officially representing the community in public spaces. -Examples of representing our community include using an official e-mail address, -posting via an official social media account, or acting as an appointed -representative at an online or offline event. - -## Enforcement - -Instances of abusive, harassing, or otherwise unacceptable behavior may be -reported to the community leaders responsible for enforcement at info@cloudberrydb.org. -All complaints will be reviewed and investigated promptly and fairly. - -All community leaders are obligated to respect the privacy and security of the -reporter of any incident. - -## Enforcement Guidelines - -Community leaders will follow these Community Impact Guidelines in determining -the consequences for any action they deem in violation of this Code of Conduct: - -### 1. Correction - -**Community Impact**: Use of inappropriate language or other behavior deemed -unprofessional or unwelcome in the community. - -**Consequence**: A private, written warning from community leaders, providing -clarity around the nature of the violation and an explanation of why the -behavior was inappropriate. A public apology may be requested. - -### 2. Warning - -**Community Impact**: A violation through a single incident or series of -actions. - -**Consequence**: A warning with consequences for continued behavior. No -interaction with the people involved, including unsolicited interaction with -those enforcing the Code of Conduct, for a specified period of time. This -includes avoiding interactions in community spaces as well as external channels -like social media. Violating these terms may lead to a temporary or permanent -ban. - -### 3. Temporary Ban - -**Community Impact**: A serious violation of community standards, including -sustained inappropriate behavior. - -**Consequence**: A temporary ban from any sort of interaction or public -communication with the community for a specified period of time. No public or -private interaction with the people involved, including unsolicited interaction -with those enforcing the Code of Conduct, is allowed during this period. -Violating these terms may lead to a permanent ban. - -### 4. Permanent Ban - -**Community Impact**: Demonstrating a pattern of violation of community -standards, including sustained inappropriate behavior, harassment of an -individual, or aggression toward or disparagement of classes of individuals. - -**Consequence**: A permanent ban from any sort of public interaction within the -community. - -## Attribution - -This Code of Conduct is adapted from the [Contributor Covenant][homepage], -version 2.1, available at -[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1]. - -Community Impact Guidelines were inspired by -[Mozilla's code of conduct enforcement ladder][Mozilla CoC]. - -For answers to common questions about this code of conduct, see the FAQ at -[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at -[https://www.contributor-covenant.org/translations][translations]. - -[homepage]: https://www.contributor-covenant.org -[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html -[Mozilla CoC]: https://github.com/mozilla/diversity -[FAQ]: https://www.contributor-covenant.org/faq -[translations]: https://www.contributor-covenant.org/translations +If you observe behavior that violates those rules please follow the +[ASF reporting +guidelines](https://www.apache.org/foundation/policies/conduct#reporting-guidelines). diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index be139b9f8ef..6cf5b3370ca 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,92 +1,88 @@ -Cloudberry Database community welcomes contributions from anyone, new +Apache Cloudberry (Incubating) welcomes contributions from anyone, new and experienced! We appreciate your interest in contributing. This guide will help you get started with the contribution. ## Code of Conduct -Everyone who participates in Cloudberry Database, either as a user or -a contributor, is obliged to follow our community [Code of -Conduct](./CODE_OF_CONDUCT.md). Every violation against it will be -reviewed and investigated and will result in a response that is deemed -necessary and appropriate to the circumstances. The moderator team is -obligated to maintain confidentiality regarding the reporter of an -incident. +Everyone who participates in Cloudberry, either as a user or a +contributor, is obliged to follow the [Code of +Conduct](./CODE_OF_CONDUCT.md). -Some behaviors that contribute to creating a positive environment -include: +We strive to: -* Use welcoming and inclusive language. -* Respect differing viewpoints and experiences. -* Accept constructive criticism gracefully. -* Foster what's best for the community. -* Show empathy for community members. +* Be open. +* Be empathetic, welcoming, friendly, and patient. +* Be collaborative. +* Be inquisitive. +* Be careful in the words that we choose. +* Be concise. +* Step down considerately. ## Find a Way to Contribute -There are many ways to contribute to Cloudberry Database. Here are -some ways you need to get started. The most common contributions -include code, documentation, and community support. +There are many ways to contribute to Cloudberry. Here are some ways +you need to get started. The most common contributions include code, +documentation, and community support. You can participate by: -* [Contributing code](https://cloudberrydb.org/contribute/code). -* [Improving documentation](https://cloudberrydb.org/contribute/doc). +* [Contributing code](https://cloudberry.apache.org/contribute/code). +* [Improving + documentation](https://cloudberry.apache.org/contribute/doc). * Helping out in the Slack channels, see [Slack - Guide](https://cloudberrydb.org/community/slack) + Guide](https://cloudberry.apache.org/community/slack) * Answering questions on [GitHub - Discussions](https://github.com/apache/cloudberrydb/discussions/categories/q-a). + Discussions](https://github.com/apache/cloudberry/discussions/categories/q-a). * Investigating [GitHub - issues](https://github.com/cloudberrydb/cloudberrydb/issues). + issues](https://github.com/apache/cloudberry/issues). * [Reporting a new - bug](https://github.com/cloudberrydb/cloudberrydb/issues/new/choose). + bug](https://github.com/apache/cloudberry/issues/new/choose). * [Sharing ideas for new - features](https://github.com/apache/cloudberrydb/discussions/new?category=ideas-feature-requests). + features](https://github.com/apache/cloudberry/discussions/new?category=ideas-feature-requests). * Helping review [Pull - Requests](https://github.com/cloudberrydb/cloudberrydb/pulls) or - [Proposals](https://github.com/apache/cloudberrydb/discussions/categories/proposal). -* Proposing your proposal, see [Proposal Guide](https://cloudberrydb.org/contribute/proposal). + Requests](https://github.com/apache/cloudberry/pulls) or + [Proposals](https://github.com/apache/cloudberry/discussions/categories/proposal). +* Proposing your proposal, see [Proposal + Guide](https://cloudberry.apache.org/contribute/proposal). * [Reporting security issues](./SECURITY.md). * Testing code, testing releases. * Creating educational content (Blog posts, tutorials, videos, etc.) * Spreading the word about Cloudberry Database on social media(eg, Twitter, LinkedIn). * ... -* More things to make Cloudberry Database better. +* More things to make Cloudberry better. ## Getting Help Feel free to reach out to us in [Slack `#dev` -channels](https://cloudberrydb.org/community/slack) or [GitHub -Discussions](https://github.com/cloudberrydb/cloudberrydb/discussions) -when your contribution is blocked, especially when making your first +channels](https://cloudberry.apache.org/community/slack) or [GitHub +Discussions](https://github.com/apache/cloudberry/discussions) when +your contribution is blocked, especially when making your first contribution. Don't be shy, we're happy to help. -As the next-generation unified database, Cloudberry Database cannot -grow without the support from the community. Hope to make our mission -with you! +Cloudberry cannot grow without the support from the community. Hope to +make our mission with you! ## Benefits of Contribution -There are many reasons to contribute to Cloudberry Database and open -source projects in general. Here are some of the benefits of -participating: +There are many reasons to contribute to Cloudberry and open source +projects in general. Here are some of the benefits of participating: -* Growing your network. Working with Cloudberry Database in open -source can help connect you with people working on similar things. You -can get help or give help, and you might even make a real-life -acquaintance! +* Growing your network. Working with Cloudberry in open source can +help connect you with people working on similar things. You can get +help or give help, and you might even make a real-life acquaintance! -* Improving your skills. When you work on a Cloudberry Database issue -or Pull Request, inevitably you'll learn more about how something -works in our project; either by asking questions and gathering info or -by digging deeper into the code yourself. There’s a skill-building -benefit to contributing to open source projects. +* Improving your skills. When you work on a Cloudberry issue or Pull +Request, inevitably you'll learn more about how something works in our +project; either by asking questions and gathering info or by digging +deeper into the code yourself. There’s a skill-building benefit to +contributing to open source projects. * Becoming an expert. You might start new to a project like Cloudberry -Database or PostgreSQL, and by building things and opening issues when -you encounter a new challenge or a bug, you’ll learn a ton over -time. You could find your knowledge of said project has grown so much -that you’ve become an expert. +or PostgreSQL, and by building things and opening issues when you +encounter a new challenge or a bug, you’ll learn a ton over time. You +could find your knowledge of said project has grown so much that +you’ve become an expert. * Speaking at conferences or more community events. With those skills you’ve earned yourself working in open source, you can let other @@ -95,7 +91,7 @@ these community activities. * Getting free swag! By participating in GitHub and other community channels, you can become eligible for free swag that the Cloudberry -Database team offers as a way to say thank you. +team offers as a way to say thank you. There are undoubtedly more benefits than those listed here. Hope you -enjoy your contribution to the Cloudberry Database community! +enjoy your contribution to the Cloudberry community! diff --git a/README.md b/README.md index c2adb781d29..29eceb5f9fc 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,5 @@ +# Apache Cloudberry (Incubating) +

@@ -6,79 +8,55 @@

-

- Next Generation Unified Database for Analytics and AI -

- -[![Website](https://img.shields.io/badge/Website-eebc46)](https://cloudberrydb.org) -[![Documentation](https://img.shields.io/badge/Documentation-acd94a)](https://cloudberrydb.org/docs) -[![Slack](https://img.shields.io/badge/Join_Slack-6a32c9)](https://communityinviter.com/apps/cloudberrydb/welcome) -[![Twitter Follow](https://img.shields.io/twitter/follow/cloudberrydb)](https://twitter.com/cloudberrydb) -[![WeChat](https://img.shields.io/badge/WeChat-eebc46)](https://cloudberrydb.org/community/wechat) -[![Youtube](https://img.shields.io/badge/Youtube-gebc46)](https://youtube.com/@cloudberrydb) -[![GitHub Discussions](https://img.shields.io/github/discussions/cloudberrydb/cloudberrydb)](https://github.com/apache/cloudberrydb/discussions) -![GitHub commit activity(branch)](https://img.shields.io/github/commit-activity/m/cloudberrydb/cloudberrydb) -![GitHub contributors](https://img.shields.io/github/contributors/cloudberrydb/cloudberrydb) -![GitHub License](https://img.shields.io/github/license/cloudberrydb/cloudberrydb) -![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fcloudberrydb%2Fcloudberrydb.svg?type=shield) -[![cbdb pipeline](https://github.com/cloudberrydb/cloudberrydb/actions/workflows/build.yml/badge.svg)](https://github.com/cloudberrydb/cloudberrydb/actions/workflows/build.yml) +[![Website](https://img.shields.io/badge/Website-eebc46)](https://cloudberry.apache.org) +[![Documentation](https://img.shields.io/badge/Documentation-acd94a)](https://cloudberry.apache.org/docs) +[![Slack](https://img.shields.io/badge/Join_Slack-6a32c9)](https://inviter.co/apache-cloudberry) +[![Twitter Follow](https://img.shields.io/twitter/follow/ASFCloudberry)](https://twitter.com/ASFCloudberry) +[![WeChat](https://img.shields.io/badge/WeChat-eebc46)](https://cloudberry.apache.org/community/wechat) +[![Youtube](https://img.shields.io/badge/Youtube-gebc46)](https://youtube.com/@ApacheCloudberry) +[![GitHub Discussions](https://img.shields.io/github/discussions/apache/cloudberry)](https://github.com/apache/cloudberry/discussions) +![GitHub commit activity(branch)](https://img.shields.io/github/commit-activity/m/apache/cloudberry) +![GitHub contributors](https://img.shields.io/github/contributors/apache/cloudberry) +![GitHub License](https://img.shields.io/github/license/apache/cloudberry) +[![Apache Cloudberry Build](https://github.com/apache/cloudberry/actions/workflows/build-cloudberry.yml/badge.svg)](https://github.com/apache/cloudberry/actions/workflows/build-cloudberry.yml) --------- -## What's Cloudberry Database - -Cloudberry Database (`CBDB` or `CloudberryDB` for short) is created by a bunch -of original Greenplum Database developers and ASF committers. We aim to bring -modern computing capabilities to the traditional distributed MPP database to -support Analytics and AI/ML workloads in one platform. - -As a derivative of Greenplum Database 7, Cloudberry Database is compatible -with Greenplum Database, but it's shipped with a newer PostgreSQL 14.4 kernel -(scheduled kernel upgrade yearly) and a bunch of features Greenplum Database -lacks or does not support. View the [Cloudberry Database vs Greenplum -Database](https://cloudberrydb.org/docs/cbdb-vs-gp-features) doc for details. - -## Roadmap +## Introduction -You can check our [Cloudberry Database Roadmap -2024](https://github.com/apache/cloudberrydb/discussions/369) out to see the -product plans and goals we want to achieve in 2024. Welcome to share your -thoughts and ideas to join us in shaping the future of the Cloudberry -Database. +Apache Cloudberry (Incubating), created by the original developers of +Greenplum Database, is one advanced and mature open-source Massively Parallel +Processing (MPP) database, which evolves from the open-source version of the +Pivotal Greenplum Database®️ but features a newer PostgreSQL kernel and more +advanced enterprise capabilities. It can serve as a data warehouse and can +also be used for large-scale analytics and AI/ML workloads. ## Build and try out ### Build from source -You can follow [these guides](./deploy/build) to build the Cloudberry Database on -Linux OS(including CentOS, RHEL/Rocky Linux, and Ubuntu) and macOS. +You can follow [these guides](./deploy/build) to build Cloudberry on +Linux OS (including RHEL/Rocky Linux, and Ubuntu) and macOS. ### Try out quickly -Welcome to try out Cloudberry Database via building [one Docker-based -Sandbox](https://github.com/cloudberrydb/bootcamp), which is tailored to help -you gain a basic understanding of Cloudberry Database's capabilities and -features a range of materials, including tutorials, sample code, and crash -courses. +Welcome to try out Cloudberry via building [one Docker-based +Sandbox](https://github.com/apache/cloudberry-bootcamp), which is tailored to +help you gain a basic understanding of Cloudberry's capabilities and features +a range of materials, including tutorials, sample code, and crash courses. ## Repositories -This is the main repository for Cloudberry Database. Alongside this, there are -several ecosystem repositories for the Cloudberry Database, including the +This is the main repository for Apache Cloudberry (Incubating). Alongside +this, there are several ecosystem repositories for Cloudberry, including the website, extensions, connectors, adapters, and other utilities. -* [cloudberrydb/cloudberrydb-site](https://github.com/cloudberrydb/cloudberrydb-site): website and documentation sources. -* [cloudberrydb/bootcamp](https://github.com/cloudberrydb/bootcamp): help you quickly try out Cloudberry Database via one Docker-based Sandbox. -* [cloudberrydb/gpbackup](https://github.com/cloudberrydb/gpbackup): backup utility for Cloudberry Database. -* [cloudberrydb/gp-common-go-libs](https://github.com/cloudberrydb/gp-common-go-libs): gp-common-go-libs for Cloudberry Database. -* [cloudberrydb/gpbackup-s3-plugin](https://github.com/cloudberrydb/gpbackup-s3-plugin): S3 plugin for use with Cloudberry Database backup utility. -* [cloudberrydb/filedump](https://github.com/cloudberrydb/filedump): format heap/index/control files into a human-readable form. -* [cloudberrydb/postgis](https://github.com/cloudberrydb/postgis): PostGIS for Cloudberry Database. -* [cloudberrydb/pxf](https://github.com/cloudberrydb/pxf): Platform Extension Framework (PXF) for Cloudberry Database. -* [cloudberrydb/madlib](https://github.com/cloudberrydb/madlib): MADlib® for Cloudberry Database. -* [cloudberrydb/plr](https://github.com/cloudberrydb/plr): PL/R for Cloudberry Database. -* [cloudberrydb/pljava](https://github.com/cloudberrydb/pljava): PL/Java for Cloudberry Database. -* More is coming... +* [apache/cloudberry-site](https://github.com/apache/cloudberry-site): website and documentation sources. +* [apache/cloudberry-bootcamp](https://github.com/apache/cloudberry-bootcamp): help you quickly try out Cloudberry via one Docker-based Sandbox. +* [apache/cloudberry-gpbackup](https://github.com/apache/cloudberry-gpbackup): backup utility for Cloudberry. +* [apache/cloudberry-go-libs](https://github.com/apache/cloudberry-go-libs): go-libs for Cloudberry. +* [apache/cloudberry-gpbackup-s3-plugin](https://github.com/apache/cloudberry-gpbackup-s3-plugin): S3 plugin for use with Cloudberry backup utility. +* [apache/cloudberry-pxf](https://github.com/apache/cloudberry-pxf): Platform Extension Framework (PXF) for Cloudberry. ## Community & Support @@ -87,55 +65,55 @@ feedback, and chat: | Type | Description | |------|-------------| -| Slack | [Click to Join](https://communityinviter.com/apps/cloudberrydb/welcome) the real-time chat on Slack for QA, Dev, Events, and more. Don't miss out! Check out the [Slack guide](https://cloudberrydb.org/community/slack) to learn more. | -| Q&A | Ask for help when running/developing Cloudberry Database, visit [GitHub Discussions - QA](https://github.com/apache/cloudberrydb/discussions/categories/q-a). | -| New ideas / Feature Requests | Share ideas for new features, visit [GitHub Discussions - Ideas](https://github.com/apache/cloudberrydb/discussions/categories/ideas-feature-requests). | -| Report bugs | Problems and issues in Cloudberry Database core. If you find bugs, welcome to submit them [here](https://github.com/cloudberrydb/cloudberrydb/issues). | -| Report a security vulnerability | View our [security policy](https://github.com/cloudberrydb/cloudberrydb/security/policy) to learn how to report and contact us. | -| Community events | Including meetups, webinars, conferences, and more events, visit the [Events page](https://cloudberrydb.org/community/events) and subscribe events calendar. | -| Documentation | [Official documentation](https://cloudberrydb.org/docs/) for Cloudberry Database. You can explore it to discover more details about us. | - -When you are involved, please follow our community [Code of -Conduct](https://cloudberrydb.org/community/coc) to help create a safe space -for everyone. +| Slack | [Click to Join](https://inviter.co/apache-cloudberry) the real-time chat on Slack for QA, Dev, Events, and more. Don't miss out! Check out the [Slack guide](https://cloudberry.apache.org/community/slack) to learn more. | +| Q&A | Ask for help when running/developing Cloudberry, visit [GitHub Discussions - QA](https://github.com/apache/cloudberry/discussions/categories/q-a). | +| New ideas / Feature Requests | Share ideas for new features, visit [GitHub Discussions - Ideas](https://github.com/apache/cloudberry/discussions/categories/ideas-feature-requests). | +| Report bugs | Problems and issues in Apache Cloudberry core. If you find bugs, welcome to submit them [here](https://github.com/apache/cloudberrydb/issues). | +| Report a security vulnerability | View our [security policy](https://github.com/apache/cloudberry/security/policy) to learn how to report and contact us. | +| Community events | Including meetups, webinars, conferences, and more events, visit the [Events page](https://cloudberry.apache.org/community/events) and subscribe events calendar. | +| Documentation | [Official documentation](https://cloudberry.apache.org/docs/) for Cloudberry. You can explore it to discover more details about us. | ## Contribution -We believe in the Apache Way "Community Over Code" and we want to make -Cloudberry Database a community-driven project. - Contributions can be diverse, such as code enhancements, bug fixes, feature proposals, documents, marketing, and so on. No contribution is too small, we -encourage all types of contributions. Cloudberry Database community welcomes +encourage all types of contributions. Cloudberry community welcomes contributions from anyone, new and experienced! Our [contribution -guide](https://cloudberrydb.org/contribute) will help you get started with the -contribution. +guide](https://cloudberry.apache.org/contribute) will help you get started +with the contribution. | Type | Description | |----|---------------| -| Code contribution | Learn how to contribute code to the Cloudberry Database, including coding preparation, conventions, workflow, review, and checklist following the [code contribution guide](https://cloudberrydb.org/contribute/code).| -| Submit the proposal | Proposing major changes to Cloudberry Database through [proposal guide](https://cloudberrydb.org/contribute/proposal).| -| Doc contribution | We need you to join us to help us improve the documentation, see the [doc contribution guide](https://cloudberrydb.org/contribute/doc).| - -## Contributors Wall - -Thanks to all the people who already contributed! +| Code contribution | Learn how to contribute code to the Cloudberry, including coding preparation, conventions, workflow, review, and checklist following the [code contribution guide](https://cloudberry.apache.org/contribute/code).| +| Submit the proposal | Proposing major changes to Cloudberry through [proposal guide](https://cloudberry.apache.org/contribute/proposal).| +| Doc contribution | We need you to join us to help us improve the documentation, see the [doc contribution guide](https://cloudberry.apache.org/contribute/doc).| - - - +## Roadmap -Please note that the images shown above highlight the avatars of our -active and upstream contributors while not including anonymous -contributors. To view all the contributors, you can click on the images. +You can check our [Cloudberry Roadmap +2024](https://github.com/orgs/cloudberrydb/discussions/369) out to see the +product plans and goals we want to achieve in 2024. Welcome to share your +thoughts and ideas to join us in shaping the future of Apache Cloudberry +(Incubating). (We will update the Roadmap after entering the Incubator.) ## Acknowledgment Thanks to [PostgreSQL](https://www.postgresql.org/), [Greenplum Database](https://greenplum.org/) and other great open source projects to make -Cloudberry Database has a sound foundation. +Apache Cloudberry has a sound foundation. ## License -Cloudberry Database is released under the [Apache License, Version -2.0](https://github.com/cloudberrydb/cloudberrydb/blob/main/LICENSE). +Cloudberry is licensed under the Apache License, Version 2.0. For details, see +the [LICENSE](./LICENSE). + +## ASF Incubator disclaimer + +Apache Cloudberry is an effort undergoing incubation at The Apache Software +Foundation (ASF), sponsored by the Apache Incubator. Incubation is required +for all newly accepted projects until a further review indicates that the +infrastructure, communications, and decision making process have stabilized in +a manner consistent with other successful ASF projects. While incubation +status is not necessarily a reflection of the completeness or stability of the +code, it does indicate that the project has yet to be fully endorsed by the +ASF. diff --git a/SECURITY.md b/SECURITY.md index 36b48877d28..1b586a9a276 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -1,64 +1,8 @@ -Thanks for helping make Cloudberry Database safe! +# Security Policy ---- +The Apache Cloudberry (Incubating) project follows the standard processes as +set out by the [ASF security team](https://www.apache.org/security/). -## Reporting Security Issues - -To report a security issue, please email -[security@cloudberrydb.org](mailto:security@cloudberrydb.org). This -project follows a 90-day disclosure timeline. We will publish the -[security -advisories](https://github.com/cloudberrydb/cloudberrydb/security/advisories) -via GitHub. - -You should receive a response within 2 weeks. If for some reason you -do not, please follow up via email to ensure we received your original -message. - -Please include the requested information listed below (as much as you -can provide) to help us better understand the nature and scope of the -possible issue: - -* Type of issue (e.g. buffer overflow, SQL injection, cross-site - scripting, etc.) -* Full paths of source file(s) related to the manifestation of the - issue -* The location of the affected source code (tag/branch/commit or - direct URL) -* Any special configuration required to reproduce the issue -* Step-by-step instructions to reproduce the issue -* Proof-of-concept or exploit code (if possible) -* Impact of the issue, including how an attacker might exploit the - issue - -This information will help us triage your report more quickly. - -## Do not - -For better collaboration, we hope you: - -- Do not file public issues on GitHub for security vulnerabilities. -- Do not report non-security-impacting bugs through this channel. If - you have any questions on using, development, please use [GitHub - Issues, Discussions or - Slack](https://github.com/cloudberrydb/cloudberrydb/issues/new/choose) - instead. - -## Handling Process - -Here's an overview of the security issues handling process: - -* The reporter reports the security issues to the Cloudberry Database - team. -* The Cloudberry Database team investigates the report and decides to - accept or reject the report. If our team rejects the report, the - team will explain why to the reporter. If we accept the report, our - team will work privately with the reporter to fix the security - issues. -* Release the new version of the Cloudberry Database that includes the - fix. -* Public the security issues. - -## Preferred Languages - -We prefer all communications to be in English. +Please report any security issues to +[private@cloudberry.apache.org](mailto:private@cloudberry.apache.org) or to +(security@apache.org)[mailto:security@apache.org].