-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update the basic community files (#1)
For building a healthy community, we add some basic community files like PR request, issue template, contribution guide, and more.
- Loading branch information
Showing
11 changed files
with
445 additions
and
129 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,63 @@ | ||
name: "\U0001F41B Bug Report" | ||
description: Problems and issues with code in gp-common-go-libs for CloudberryDB. | ||
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." | ||
- type: textarea | ||
attributes: | ||
label: Cloudberry Database version | ||
description: What version are you using? | ||
- type: textarea | ||
attributes: | ||
label: What happened | ||
description: Describe what happened. | ||
placeholder: > | ||
Please provide the context in which the problem occurred and explain what happened | ||
validations: | ||
required: true | ||
- type: textarea | ||
attributes: | ||
label: What you think should happen instead | ||
description: What do you think went wrong? | ||
placeholder: > | ||
Please explain why you think the behavior is erroneous. It is extremely helpful if you copy&paste the fragment of logs showing the exact error messages or wrong behavior. If you can provide some screenshots or videos, you can include files by dragging and dropping them here. | ||
- type: textarea | ||
attributes: | ||
label: How to reproduce | ||
description: > | ||
What should we do to reproduce the problem? Any SQL commands or operations? | ||
placeholder: > | ||
Please make sure you provide a reproducible step-by-step case of how to reproduce the problem as minimally and precisely as possible. Remember that non-reproducible issues will be closed! Opening a discussion is recommended as a first step. | ||
- type: input | ||
attributes: | ||
label: Operating System | ||
description: What Operating System are you using? | ||
placeholder: "You can get it via `cat /etc/os-release` for example" | ||
- type: textarea | ||
attributes: | ||
label: Anything else | ||
description: Anything else we need to know? | ||
placeholder: > | ||
How often does this problem occur? (Once? Every time? Only when certain conditions are met?) Any relevant logs to include? Put them here. | ||
- type: checkboxes | ||
attributes: | ||
label: Are you willing to submit PR? | ||
description: > | ||
This is absolutely not required, but we are happy to guide you in the contribution process, especially if you already understand how to implement the fix. | ||
options: | ||
- label: Yes, I am willing to submit a PR! | ||
- type: checkboxes | ||
attributes: | ||
label: Code of Conduct | ||
description: The Code of Conduct helps create a safe space for everyone. We require that everyone agrees to it. | ||
options: | ||
- label: > | ||
I agree to follow this project's | ||
[Code of Conduct](https://cloudberrydb.org/community/coc). | ||
required: true | ||
- type: markdown | ||
attributes: | ||
value: "Thanks for completing our form!" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
blank_issues_enabled: false | ||
contact_links: | ||
- name: 🙏🏻 Q&A | ||
url: https://github.com/orgs/cloudberrydb/discussions/categories/q-a | ||
about: Ask for help when running/developing Cloudberry Database. | ||
- name: 💡️ New Ideas / Feature Requests | ||
url: https://github.com/orgs/cloudberrydb/discussions/categories/ideas-feature-requests | ||
about: Share ideas for new features. | ||
- name: 🎙️ Submit Your Proposal | ||
url: https://github.com/orgs/cloudberrydb/discussions/categories/proposal | ||
about: As a developer, proposing any major change or enhancement to Cloudberry Database. | ||
- name: 💬️ Join Slack for Real-time Chat | ||
url: https://communityinviter.com/apps/cloudberrydb/welcome | ||
about: Real-time chat including QA, Dev, Events and more. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
<!--Thank you for contributing! --> | ||
<!--In case of an existing issue or discussions, please reference it--> | ||
fix #ISSUE_Number | ||
<!--Remove this section if no corresponding issue.--> | ||
|
||
--- | ||
|
||
## Change logs | ||
|
||
> Describe your change clearly, including what problem is being solved or what document is being added or updated. | ||
## Contributor's checklist | ||
|
||
Here are some reminders before you submit your pull request: | ||
|
||
* Make sure that your Pull Request has a clear title and commit message. You can take the [Git commit template](https://github.com/cloudberrydb/cloudberrydb/blob/main/.gitmessage) as a reference. | ||
* Sign the Contributor License Agreement as prompted for your first-time contribution (*One-time setup*). | ||
* Learn the [code contribution](https://cloudberrydb.org/contribute/code) and [doc contribution](https://cloudberrydb.org/contribute/doc) guides for better collaboration. | ||
* List your communications in the [GitHub Issues](https://github.com/cloudberrydb/cloudberrydb-site/issues) or [Discussions](https://github.com/orgs/cloudberrydb/discussions) (if has or needed). | ||
* Feel free to ask for the cloudberrydb team to help review and approve. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,131 @@ | ||
# Contributor Covenant Code of Conduct | ||
|
||
## Our Pledge | ||
|
||
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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,77 @@ | ||
Cloudberry Database community 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. | ||
|
||
Some behaviors that contribute to creating a positive environment include: | ||
|
||
* 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. | ||
|
||
## GitHub Contribution Workflow | ||
|
||
1. Fork this repo to your own GitHub account. | ||
2. Clone down the repo to your local system. | ||
|
||
``` | ||
git clone https://github.com/your-user-name/gp-common-go-libs.git | ||
``` | ||
|
||
3. Add the upstream repo. (You only have to do this once, not every time.) | ||
|
||
``` | ||
git remote add upstream https://github.com/cloudberrydb/gp-common-go-libs.git | ||
``` | ||
|
||
4. Create a new branch to hold your work. | ||
|
||
``` | ||
git checkout -b new-branch-name | ||
``` | ||
|
||
5. Work on your new code. | ||
6. Commit your changes. | ||
|
||
``` | ||
git add <the change files> | ||
git commit | ||
``` | ||
|
||
7. Push your changes to your GitHub repo. | ||
|
||
``` | ||
git push origin new-branch-name | ||
``` | ||
|
||
8. Open a PR(Pull Request). | ||
|
||
Go to the repo on GitHub. There will be a message about your recently pushed | ||
branch, asking if you would like to open a pull request. Follow the prompts, | ||
compare across repositories, and submit the PR. | ||
|
||
9. Get your code reviewed. | ||
10. Congratulations! Once your PR is approved, and passes the CI/CD without | ||
errors, then the code will be merged. Your code will be shipped in the recent | ||
future releases. | ||
|
||
## Sync your branch with the upstream | ||
|
||
Before working on your next contribution, make sure your local repository is | ||
up to date: | ||
|
||
``` | ||
git checkout main | ||
git fetch upstream | ||
git rebase upstream/main | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,27 @@ | ||
# gp-common-go-libs [![Concourse Build Status](https://prod.ci.gpdb.pivotal.io/api/v1/teams/main/pipelines/gp-common-go-libs/badge)] | ||
# `gp-common-go-libs` for CloudberryDB | ||
|
||
[![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) | ||
[![Website](https://img.shields.io/badge/Visit%20Website-eebc46)](https://cloudberrydb.org) | ||
[![GitHub Discussions](https://img.shields.io/github/discussions/cloudberrydb/cloudberrydb)](https://github.com/orgs/cloudberrydb/discussions) | ||
![GitHub License](https://img.shields.io/github/license/cloudberrydb/cloudberrydb) | ||
|
||
--- | ||
|
||
This project is a fork of the `Greenplum gp-common-go-libs`, which is a | ||
dependency for the [gpbackup](https://github.com/cloudberrydb/gpbackup) | ||
utility in CloudberryDB. | ||
|
||
Please note that this repository is only maintained for CloudberryDB 1.0 and | ||
its later versions. | ||
|
||
## License | ||
|
||
Licensed under Apache License Version 2.0. For more details, please refer to | ||
the [LICENSE](./LICENSE). | ||
|
||
## Acknowledgment | ||
|
||
Thanks to all the gp-common-go-libs contributors, more details in its [GitHub | ||
page](https://github.com/greenplum-db/gp-common-go-libs). | ||
|
||
Pipeline lives [here](https://prod.ci.gpdb.pivotal.io/teams/main/pipelines/gp-common-go-libs) |
Oops, something went wrong.