Skip to content

Commit d1059fe

Browse files
tuhaihetuhaihe
committed
Update basic community files for repo
1 parent 723ba54 commit d1059fe

File tree

11 files changed

+426
-351
lines changed

11 files changed

+426
-351
lines changed

‎.asf.yaml‎

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
#
2+
# Licensed to the Apache Software Foundation (ASF) under one or more
3+
# contributor license agreements. See the NOTICE file distributed with
4+
# this work for additional information regarding copyright ownership.
5+
# The ASF licenses this file to You under the Apache License, Version 2.0
6+
# (the "License"); you may not use this file except in compliance with
7+
# the License. You may obtain a copy of the License at
8+
#
9+
# http://www.apache.org/licenses/LICENSE-2.0
10+
#
11+
# Unless required by applicable law or agreed to in writing, software
12+
# distributed under the License is distributed on an "AS IS" BASIS,
13+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14+
# See the License for the specific language governing permissions and
15+
# limitations under the License.
16+
#
17+
18+
github:
19+
description: Backup Utility for Apache Cloudberry (Incubating)
20+
homepage: https://cloudberry.apache.org
21+
labels:
22+
- mpp
23+
- big-data
24+
- data-warehouse
25+
- data-analysis
26+
- olap
27+
- distributed-database
28+
- database
29+
- postgres
30+
- postgresql
31+
- greenplum
32+
- cloudberry
33+
- backup
34+
features:
35+
# Enable wiki for documentation
36+
wiki: false
37+
# Enable issues management
38+
issues: true
39+
# Enable projects for project management boards
40+
projects: false
41+
enabled_merge_buttons:
42+
# enable squash button:
43+
squash: true
44+
# disable merge button:
45+
merge: false
46+
# enable rebase button:
47+
rebase: true
48+
protected_branches:
49+
main:
50+
required_status_checks:
51+
# strict means "Require branches to be up to date before merging".
52+
strict: true
53+
# contexts are the names of checks that must pass.
54+
contexts:
55+
- build_and_unit_test
56+
required_pull_request_reviews:
57+
dismiss_stale_reviews: false
58+
required_approving_review_count: 1
59+
# squash or rebase must be allowed in the repo for this setting to be set to true.
60+
required_linear_history: true
61+
62+
required_signatures: false
63+
64+
# requires all conversations to be resolved before merging is possible
65+
required_conversation_resolution: true
66+
del_branch_on_merge: true
67+
dependabot_alerts: true
68+
dependabot_updates: false
69+
protected_tags:
70+
- "v*.*.*"
71+
- "[0-9]*.*"
72+
notifications:
73+
commits: commits@cloudberry.apache.org
74+
issues: commits@cloudberry.apache.org
75+
pullrequests: commits@cloudberry.apache.org
76+
pullrequests_bot_dependabot: private@cloudberry.apache.org

‎.github/ISSUE_TEMPLATE/bug-report.yml‎

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
# --------------------------------------------------------------------
2+
#
3+
# Licensed to the Apache Software Foundation (ASF) under one or more
4+
# contributor license agreements. See the NOTICE file distributed
5+
# with this work for additional information regarding copyright
6+
# ownership. The ASF licenses this file to You under the Apache
7+
# License, Version 2.0 (the "License"); you may not use this file
8+
# except in compliance with the License. You may obtain a copy of the
9+
# License at
10+
#
11+
# http://www.apache.org/licenses/LICENSE-2.0
12+
#
13+
# Unless required by applicable law or agreed to in writing, software
14+
# distributed under the License is distributed on an "AS IS" BASIS,
15+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
16+
# implied. See the License for the specific language governing
17+
# permissions and limitations under the License.
18+
#
19+
# --------------------------------------------------------------------
20+
21+
name: "\U0001F41B Bug Report"
22+
description: Problems and issues with code in cloudberry-backup for Apache Cloudberry.
23+
title: "[Bug] "
24+
labels: ["type: Bug"]
25+
body:
26+
- type: markdown
27+
attributes:
28+
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."
29+
- type: textarea
30+
attributes:
31+
label: Apache Cloudberry and cloudberry-backup version
32+
description: What version are you using?
33+
- type: textarea
34+
attributes:
35+
label: What happened
36+
description: Describe what happened.
37+
placeholder: >
38+
Please provide the context in which the problem occurred and explain what happened
39+
validations:
40+
required: true
41+
- type: textarea
42+
attributes:
43+
label: What you think should happen instead
44+
description: What do you think went wrong?
45+
placeholder: >
46+
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.
47+
- type: textarea
48+
attributes:
49+
label: How to reproduce
50+
description: >
51+
What should we do to reproduce the problem? Any SQL commands or operations?
52+
placeholder: >
53+
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.
54+
- type: input
55+
attributes:
56+
label: Operating System
57+
description: What Operating System are you using?
58+
placeholder: "You can get it via `cat /etc/os-release` for example"
59+
- type: textarea
60+
attributes:
61+
label: Anything else
62+
description: Anything else we need to know?
63+
placeholder: >
64+
How often does this problem occur? (Once? Every time? Only when certain conditions are met?) Any relevant logs to include? Put them here.
65+
- type: checkboxes
66+
attributes:
67+
label: Are you willing to submit PR?
68+
description: >
69+
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.
70+
options:
71+
- label: Yes, I am willing to submit a PR!
72+
- type: checkboxes
73+
attributes:
74+
label: Code of Conduct
75+
description: The Code of Conduct helps create a safe space for everyone. We require that everyone agrees to it.
76+
options:
77+
- label: >
78+
I agree to follow this project's
79+
[Code of Conduct](https://github.com/apache/cloudberry/blob/main/CODE_OF_CONDUCT.md).
80+
required: true
81+
- type: markdown
82+
attributes:
83+
value: "Thanks for completing our form!"

‎.github/workflows/build_and_unit_test.yml‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,18 @@ name: build_and_unit_test
22

33
on:
44
push:
5-
branches: [ master ]
5+
branches: [ main ]
66
pull_request:
7-
branches: [ master ]
7+
branches: [ main ]
88
types: [ opened, synchronize, reopened, edited, ready_for_review ]
9+
workflow_dispatch:
910

1011
jobs:
1112

1213
build_and_unit_test:
1314
runs-on: ubuntu-latest
1415
steps:
15-
- uses: actions/checkout@v2
16+
- uses: actions/checkout@v4
1617
with:
1718
fetch-depth: 0
1819
path: go/src/github.com/apache/cloudberry-backup

‎CODE-OF-CONDUCT.md‎

Lines changed: 27 additions & 78 deletions
Original file line numberDiff line numberDiff line change
@@ -1,78 +1,27 @@
1-
# Contributor Covenant Code of Conduct
2-
3-
## Our Pledge
4-
5-
In the interest of fostering an open and welcoming environment, we as
6-
contributors and maintainers pledge to making participation in the
7-
Greenplum Database Backup project and our community a harassment-free
8-
experience for everyone, regardless of age, body size, disability,
9-
ethnicity, sex characteristics, gender identity and expression, level
10-
of experience, education, socio-economic status, nationality, personal
11-
appearance, race, religion, or sexual identity and orientation.
12-
13-
## Our Standards
14-
15-
Examples of behavior that contributes to creating a positive environment
16-
include:
17-
18-
* Using welcoming and inclusive language
19-
* Being respectful of differing viewpoints and experiences
20-
* Gracefully accepting constructive criticism
21-
* Focusing on what is best for the community
22-
* Showing empathy towards other community members
23-
24-
Examples of unacceptable behavior by participants include:
25-
26-
* The use of sexualized language or imagery and unwelcome sexual attention or
27-
advances
28-
* Trolling, insulting/derogatory comments, and personal or political attacks
29-
* Public or private harassment
30-
* Publishing others' private information, such as a physical or electronic
31-
address, without explicit permission
32-
* Other conduct which could reasonably be considered inappropriate in a
33-
professional setting
34-
35-
## Our Responsibilities
36-
37-
Project maintainers are responsible for clarifying the standards of acceptable
38-
behavior and are expected to take appropriate and fair corrective action in
39-
response to any instances of unacceptable behavior.
40-
41-
Project maintainers have the right and responsibility to remove, edit, or
42-
reject comments, commits, code, wiki edits, issues, and other contributions
43-
that are not aligned to this Code of Conduct, or to ban temporarily or
44-
permanently any contributor for other behaviors that they deem inappropriate,
45-
threatening, offensive, or harmful.
46-
47-
## Scope
48-
49-
This Code of Conduct applies both within project spaces and in public spaces
50-
when an individual is representing the project or its community. Examples of
51-
representing a project or community include using an official project e-mail
52-
address, posting via an official social media account, or acting as an appointed
53-
representative at an online or offline event. Representation of a project may be
54-
further defined and clarified by project maintainers.
55-
56-
## Enforcement
57-
58-
Instances of abusive, harassing, or otherwise unacceptable behavior may be
59-
reported by contacting the project team at oss-coc@vmware.com. All
60-
complaints will be reviewed and investigated and will result in a response that
61-
is deemed necessary and appropriate to the circumstances. The project team is
62-
obligated to maintain confidentiality with regard to the reporter of an incident.
63-
Further details of specific enforcement policies may be posted separately.
64-
65-
Project maintainers who do not follow or enforce the Code of Conduct in good
66-
faith may face temporary or permanent repercussions as determined by other
67-
members of the project's leadership.
68-
69-
## Attribution
70-
71-
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
72-
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
73-
74-
[homepage]: https://www.contributor-covenant.org
75-
76-
For answers to common questions about this code of conduct, see
77-
https://www.contributor-covenant.org/faq
78-
1+
<!--
2+
Licensed to the Apache Software Foundation (ASF) under one
3+
or more contributor license agreements. See the NOTICE file
4+
distributed with this work for additional information
5+
regarding copyright ownership. The ASF licenses this file
6+
to you under the Apache License, Version 2.0 (the
7+
"License"); you may not use this file except in compliance
8+
with the License. You may obtain a copy of the License at
9+
10+
http://www.apache.org/licenses/LICENSE-2.0
11+
12+
Unless required by applicable law or agreed to in writing,
13+
software distributed under the License is distributed on an
14+
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15+
KIND, either express or implied. See the License for the
16+
specific language governing permissions and limitations
17+
under the License.
18+
-->
19+
20+
# Code of Conduct
21+
22+
Apache Cloudberry (Incubating) follows the ASF [Code of
23+
Conduct](https://www.apache.org/foundation/policies/conduct).
24+
25+
If you observe behavior that violates those rules please follow the
26+
[ASF reporting
27+
guidelines](https://www.apache.org/foundation/policies/conduct#reporting-guidelines).

‎CONTRIBUTING.md‎

Lines changed: 30 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -1,62 +1,42 @@
1+
<!--
2+
Licensed to the Apache Software Foundation (ASF) under one
3+
or more contributor license agreements. See the NOTICE file
4+
distributed with this work for additional information
5+
regarding copyright ownership. The ASF licenses this file
6+
to you under the Apache License, Version 2.0 (the
7+
"License"); you may not use this file except in compliance
8+
with the License. You may obtain a copy of the License at
9+
10+
http://www.apache.org/licenses/LICENSE-2.0
11+
12+
Unless required by applicable law or agreed to in writing,
13+
software distributed under the License is distributed on an
14+
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15+
KIND, either express or implied. See the License for the
16+
specific language governing permissions and limitations
17+
under the License.
18+
-->
19+
120
# Contributing
221

3-
We warmly welcome and greatly appreciate contributions from the
4-
community. By participating you agree to the [code of
5-
conduct](https://github.com/apache/cloudberry-gpbackup/blob/main/CODE-OF-CONDUCT.md).
6-
Overall, we follow GPDB's comprehensive contribution policy. Please
7-
refer to it [here](https://github.com/greenplum-db/gpdb#contributing)
8-
for details.
22+
Everyone who participates in Cloudberry, either as a user or a contributor, is obliged to follow the [Code of Conduct](./CODE-OF-CONDUCT.md).
923

1024
## Getting Started
1125

12-
* Sign our [Contributor License Agreement](https://cla.vmware.com/cla/1/preview)
13-
* Fork the gpbackup repository on GitHub
14-
* Run `go get github.com/apache/cloudberry-gpbackup/...` and add your fork as a remote
26+
To get started, follow these steps:
27+
* Fork the `cloudberry-backup` repository on GitHub
28+
* Run `go get github.com/apache/cloudberry-backup/...` and add your fork as a remote
1529
* Run `make depend` to install required dependencies
1630
* Follow the README to set up your environment and run the tests
1731

1832
## Creating a change
1933

20-
* Create your own feature branch (e.g. `git checkout -b
21-
gpbackup_branch`) and make changes on this branch.
22-
* Try and follow similar coding styles as found throughout the code
23-
base.
34+
* Create your own feature branch (e.g. `git checkout -b new_branch`) and make changes on this branch.
35+
* Try and follow similar coding styles as found throughout the codebase.
2436
* Make commits as logical units for ease of reviewing.
2537
* Rebase with main often to stay in sync with upstream.
26-
* Add new tests to cover your code. We use
27-
[Ginkgo](http://onsi.github.io/ginkgo/) and
28-
[Gomega](https://onsi.github.io/gomega/) for testing.
29-
* Ensure a well written commit message as explained
30-
[here](https://chris.beams.io/posts/git-commit/).
31-
* Run `make format`, `make test`, and `make end_to_end` in your
32-
feature branch and ensure they are successful.
33-
* Push your local branch to the fork (e.g. `git push <your_fork>
34-
gpbackup_branch`)
35-
36-
## Submitting a Pull Request
37-
38-
* Create a [pull request from your
39-
fork](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork).
40-
* Address PR feedback with fixup and/or squash commits:
41-
```
42-
git add .
43-
git commit --fixup <commit SHA>
44-
-- or --
45-
git commit --squash <commit SHA>
46-
```
47-
* Once approved, before merging into main squash your fixups with:
48-
```
49-
git rebase -i --autosquash origin/main
50-
git push --force-with-lease $USER <my-feature-branch>
51-
```
52-
53-
Your contribution will be analyzed for product fit and engineering
54-
quality prior to merging. Your pull request is much more likely to be
55-
accepted if it is small and focused with a clear message that conveys
56-
the intent of your change.
57-
58-
## Community
59-
60-
Connect with Greenplum on:
61-
* [Slack](https://greenplum.slack.com/)
62-
* [Dev Google Group mailing list](https://groups.google.com/a/greenplum.org/forum/#!forum/gpdb-dev/join)
38+
* Add new tests to cover your code. We use [Ginkgo](http://onsi.github.io/ginkgo/) and [Gomega](https://onsi.github.io/gomega/) for testing.
39+
* Ensure a well written commit message as explained [here](https://chris.beams.io/posts/git-commit/).
40+
* Run `make format`, `make test`, and `make end_to_end` in your feature branch and ensure they are successful.
41+
* Push your local branch to the fork (e.g. `git push <your_fork> backup_branch`)
42+
* Create a Pull Request from your fork

0 commit comments

Comments
 (0)