Skip to content

Commit 953ab55

Browse files
tuhaihetuhaihe
committed
Add basic community files
1 parent e9c3cd2 commit 953ab55

File tree

7 files changed

+392
-7
lines changed

7 files changed

+392
-7
lines changed

Diff for: ‎.github/ISSUE_TEMPLATE/bug-report.yml

+63
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
name: "\U0001F41B Bug Report"
2+
description: Problems and issues with code in PL/Java for CloudberryDB.
3+
title: "[Bug] "
4+
labels: ["type: Bug"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
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."
9+
- type: textarea
10+
attributes:
11+
label: Cloudberry Database and PL/Java version
12+
description: What version are you using?
13+
- type: textarea
14+
attributes:
15+
label: What happened
16+
description: Describe what happened.
17+
placeholder: >
18+
Please provide the context in which the problem occurred and explain what happened
19+
validations:
20+
required: true
21+
- type: textarea
22+
attributes:
23+
label: What you think should happen instead
24+
description: What do you think went wrong?
25+
placeholder: >
26+
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.
27+
- type: textarea
28+
attributes:
29+
label: How to reproduce
30+
description: >
31+
What should we do to reproduce the problem? Any SQL commands or operations?
32+
placeholder: >
33+
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.
34+
- type: input
35+
attributes:
36+
label: Operating System
37+
description: What Operating System are you using?
38+
placeholder: "You can get it via `cat /etc/os-release` for example"
39+
- type: textarea
40+
attributes:
41+
label: Anything else
42+
description: Anything else we need to know?
43+
placeholder: >
44+
How often does this problem occur? (Once? Every time? Only when certain conditions are met?) Any relevant logs to include? Put them here.
45+
- type: checkboxes
46+
attributes:
47+
label: Are you willing to submit PR?
48+
description: >
49+
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.
50+
options:
51+
- label: Yes, I am willing to submit a PR!
52+
- type: checkboxes
53+
attributes:
54+
label: Code of Conduct
55+
description: The Code of Conduct helps create a safe space for everyone. We require that everyone agrees to it.
56+
options:
57+
- label: >
58+
I agree to follow this project's
59+
[Code of Conduct](https://cloudberrydb.org/community/coc).
60+
required: true
61+
- type: markdown
62+
attributes:
63+
value: "Thanks for completing our form!"

Diff for: ‎.github/ISSUE_TEMPLATE/config.yml

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: 🙏🏻 Q&A
4+
url: https://github.com/orgs/cloudberrydb/discussions/categories/q-a
5+
about: Ask for help when running/developing Cloudberry Database.
6+
- name: 💡️ New Ideas / Feature Requests
7+
url: https://github.com/orgs/cloudberrydb/discussions/categories/ideas-feature-requests
8+
about: Share ideas for new features.
9+
- name: 🎙️ Submit Your Proposal
10+
url: https://github.com/orgs/cloudberrydb/discussions/categories/proposal
11+
about: As a developer, proposing any major change or enhancement to Cloudberry Database.
12+
- name: 💬️ Join Slack for Real-time Chat
13+
url: https://communityinviter.com/apps/cloudberrydb/welcome
14+
about: Real-time chat including QA, Dev, Events and more.

Diff for: ‎.github/pull_request_template.md

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
<!--Thank you for contributing! -->
2+
<!--In case of an existing issue or discussions, please reference it-->
3+
fix #ISSUE_Number
4+
<!--Remove this section if no corresponding issue.-->
5+
6+
---
7+
8+
## Change logs
9+
10+
> Describe your change clearly, including what problem is being solved or what document is being added or updated.
11+
12+
## Contributor's checklist
13+
14+
Here are some reminders before you submit your pull request:
15+
16+
* 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.
17+
* Sign the Contributor License Agreement as prompted for your first-time contribution (*One-time setup*).
18+
* Learn the [code contribution](https://cloudberrydb.org/contribute/code) and [doc contribution](https://cloudberrydb.org/contribute/doc) guides for better collaboration.
19+
* 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).
20+
* Feel free to ask for the cloudberrydb team to help review and approve.

Diff for: ‎CODE-OF-CONDUCT.md

+131
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,131 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, caste, color, religion, or sexual
10+
identity and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
* Demonstrating empathy and kindness toward other people
21+
* Being respectful of differing opinions, viewpoints, and experiences
22+
* Giving and gracefully accepting constructive feedback
23+
* Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
* Focusing on what is best not just for us as individuals, but for the overall
26+
community
27+
28+
Examples of unacceptable behavior include:
29+
30+
* The use of sexualized language or imagery, and sexual attention or advances of
31+
any kind
32+
* Trolling, insulting or derogatory comments, and personal or political attacks
33+
* Public or private harassment
34+
* Publishing others' private information, such as a physical or email address,
35+
without their explicit permission
36+
* Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official e-mail address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement at [email protected].
63+
All complaints will be reviewed and investigated promptly and fairly.
64+
65+
All community leaders are obligated to respect the privacy and security of the
66+
reporter of any incident.
67+
68+
## Enforcement Guidelines
69+
70+
Community leaders will follow these Community Impact Guidelines in determining
71+
the consequences for any action they deem in violation of this Code of Conduct:
72+
73+
### 1. Correction
74+
75+
**Community Impact**: Use of inappropriate language or other behavior deemed
76+
unprofessional or unwelcome in the community.
77+
78+
**Consequence**: A private, written warning from community leaders, providing
79+
clarity around the nature of the violation and an explanation of why the
80+
behavior was inappropriate. A public apology may be requested.
81+
82+
### 2. Warning
83+
84+
**Community Impact**: A violation through a single incident or series of
85+
actions.
86+
87+
**Consequence**: A warning with consequences for continued behavior. No
88+
interaction with the people involved, including unsolicited interaction with
89+
those enforcing the Code of Conduct, for a specified period of time. This
90+
includes avoiding interactions in community spaces as well as external channels
91+
like social media. Violating these terms may lead to a temporary or permanent
92+
ban.
93+
94+
### 3. Temporary Ban
95+
96+
**Community Impact**: A serious violation of community standards, including
97+
sustained inappropriate behavior.
98+
99+
**Consequence**: A temporary ban from any sort of interaction or public
100+
communication with the community for a specified period of time. No public or
101+
private interaction with the people involved, including unsolicited interaction
102+
with those enforcing the Code of Conduct, is allowed during this period.
103+
Violating these terms may lead to a permanent ban.
104+
105+
### 4. Permanent Ban
106+
107+
**Community Impact**: Demonstrating a pattern of violation of community
108+
standards, including sustained inappropriate behavior, harassment of an
109+
individual, or aggression toward or disparagement of classes of individuals.
110+
111+
**Consequence**: A permanent ban from any sort of public interaction within the
112+
community.
113+
114+
## Attribution
115+
116+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
117+
version 2.1, available at
118+
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
119+
120+
Community Impact Guidelines were inspired by
121+
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
122+
123+
For answers to common questions about this code of conduct, see the FAQ at
124+
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
125+
[https://www.contributor-covenant.org/translations][translations].
126+
127+
[homepage]: https://www.contributor-covenant.org
128+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
129+
[Mozilla CoC]: https://github.com/mozilla/diversity
130+
[FAQ]: https://www.contributor-covenant.org/faq
131+
[translations]: https://www.contributor-covenant.org/translations

Diff for: ‎CONTRIBUTING.md

+78
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
Cloudberry Database community welcomes contributions from anyone, new and
2+
experienced! We appreciate your interest in contributing. This guide will help
3+
you get started with the contribution.
4+
5+
## Code of Conduct
6+
7+
Everyone who participates in Cloudberry Database, either as a user or a
8+
contributor, is obliged to follow our community [Code of
9+
Conduct](./CODE_OF_CONDUCT.md). Every violation against it will be reviewed
10+
and investigated and will result in a response that is deemed necessary and
11+
appropriate to the circumstances. The moderator team is obligated to maintain
12+
confidentiality regarding the reporter of an incident.
13+
14+
Some behaviors that contribute to creating a positive environment include:
15+
16+
* Use welcoming and inclusive language.
17+
* Respect differing viewpoints and experiences.
18+
* Accept constructive criticism gracefully.
19+
* Foster what's best for the community.
20+
* Show empathy for community members.
21+
22+
## GitHub Contribution Workflow
23+
24+
1. Fork this repo to your own GitHub account.
25+
2. Clone down the repo to your local system.
26+
27+
```
28+
git clone https://github.com/your-user-name/pljava.git
29+
```
30+
31+
3. Add the upstream repo. (You only have to do this once, not every time.)
32+
33+
```
34+
git remote add upstream https://github.com/cloudberrydb/pljava.git
35+
```
36+
37+
4. Create a new branch to hold your work.
38+
39+
```
40+
git checkout -b new-branch-name
41+
```
42+
43+
5. Work on your new code.
44+
45+
6. Commit your changes.
46+
47+
```
48+
git add <the change files>
49+
git commit
50+
```
51+
52+
7. Push your changes to your GitHub repo.
53+
54+
```
55+
git push origin new-branch-name
56+
```
57+
58+
8. Open a PR(Pull Request).
59+
60+
Go to the repo on GitHub. There will be a message about your recently pushed
61+
branch, asking if you would like to open a pull request. Follow the prompts,
62+
compare across repositories, and submit the PR.
63+
64+
9. Get your code reviewed.
65+
10. Congratulations! Once your PR is approved, and passes the CI/CD without
66+
errors, then the code will be merged. Your code will be shipped in the recent
67+
future releases.
68+
69+
## Sync your branch with the upstream
70+
71+
Before working on your next contribution, make sure your local repository is
72+
up to date:
73+
74+
```
75+
git checkout main
76+
git fetch upstream
77+
git rebase upstream/main
78+
```

Diff for: ‎README.md

+22-7
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,26 @@
1-
This is version of PL/Java is modified by Greenplum.
1+
# PL/Java for Cloudberry Database
22

3-
It is based on PL/Java 1.5.0 forked from:
4-
https://github.com/tada/pljava/tree/V1_5_0
3+
[![Slack](https://img.shields.io/badge/Join_Slack-6a32c9)](https://communityinviter.com/apps/cloudberrydb/welcome)
4+
[![Twitter Follow](https://img.shields.io/twitter/follow/cloudberrydb)](https://twitter.com/cloudberrydb)
5+
[![Website](https://img.shields.io/badge/Visit%20Website-eebc46)](https://cloudberrydb.org)
6+
[![GitHub Discussions](https://img.shields.io/github/discussions/cloudberrydb/cloudberrydb)](https://github.com/orgs/cloudberrydb/discussions)
57

6-
To generate the new release for enterprise PL/Java, version should follow 1.4.x for gpdb5 and 1.3.x for gpdb4.
7-
Version bump to 2.x.x for gpdb6
8+
---
89

9-
JDK requires >= 8
10+
This is a version of PL/Java for Cloudberry Database. It is based on PL/Java
11+
file 1.5.0 for Greenplum Database: https://github.com/greenplum-db/pljava.
1012

11-
Note that except adding a new git tag, you also need to bump the version in release.mk
13+
Note that if you want to generate one new release for PL/Java, except by
14+
adding a new git tag, you also need to bump the version in the release.mk
15+
file.
16+
17+
## Contribute
18+
19+
If you have improvements for PL/Java, we encourage you to make your
20+
contributions in the PL/Java upstream. See the
21+
[CONTRIBUTING](./CONTRIBUTING.md) file for how to make contributions dedicated
22+
to the PL/Java for Cloudberry Database.
23+
24+
## License and Copyright
25+
26+
You can see the [COPYRIGHT](./COPYRIGHT) file for details.

0 commit comments

Comments
 (0)