Skip to content

Commit

Permalink
Doc: update basic community files for ASF
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
tuhaihe committed Nov 26, 2024
1 parent d0454c3 commit 11333c0
Show file tree
Hide file tree
Showing 12 changed files with 223 additions and 354 deletions.
4 changes: 2 additions & 2 deletions .asf.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ notifications:
issues: [email protected]
# Route pull request notifications to commits mailing list
pullrequests: [email protected]
# 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: [email protected]
4 changes: 2 additions & 2 deletions .github/DISCUSSION_TEMPLATE/proposal.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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**.
Expand Down
8 changes: 4 additions & 4 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
@@ -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:
Expand Down Expand Up @@ -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:
Expand Down
14 changes: 7 additions & 7 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -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.
39 changes: 38 additions & 1 deletion .github/full_color_black.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
39 changes: 38 additions & 1 deletion .github/full_color_white.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!-- Thank you for your contribution to Apache Cloudberry (incubating)! -->
<!-- Thank you for your contribution to Apache Cloudberry (Incubating)! -->

Fixes #ISSUE_Number

Expand Down Expand Up @@ -46,4 +46,4 @@ Fixes #ISSUE_Number
---
<!-- Join our community:
- Mailing list: [[email protected]](https://lists.apache.org/[email protected]) (subscribe: [email protected])
- Discussions: https://github.com/apache/cloudberry/discussions -->
- Discussions: https://github.com/apache/cloudberry/discussions -->
4 changes: 2 additions & 2 deletions .gitmessage
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,8 @@ Add your commit body here
#on-behalf-of: @ORG [email protected]
# If your commit have clear context included in GitHub Issues or GitHub
# Discussions, please list them as a reference:
#See: Issue#id <https://github.com/cloudberrydb/cloudberrydb/issues/?>?
#See: Discussion#id <http://github.com/apache/cloudberrydb/discussions/>?
#See: Issue#id <https://github.com/apache/cloudberry/issues/?>?
#See: Discussion#id <http://github.com/apache/cloudberry/discussions/>?
########################################################################
#
#
Expand Down
135 changes: 6 additions & 129 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -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 [email protected].
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).
102 changes: 49 additions & 53 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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!
Loading

0 comments on commit 11333c0

Please sign in to comment.