Skip to content

Commit f19f854

Browse files
zjw1111zjw1111
authored
chore: add issue template and pr template (#4)
* chore: add issue template and pr template * fix
1 parent 74f5a76 commit f19f854

File tree

4 files changed

+167
-0
lines changed

4 files changed

+167
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.yaml‎

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
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, software
13+
# distributed under the License is distributed on an "AS IS" BASIS,
14+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
# See the License for the specific language governing permissions and
16+
# limitations under the License.
17+
################################################################################
18+
19+
# Adapted from Apache Paimon
20+
# https://github.com/apache/paimon/blob/master/.github/ISSUE_TEMPLATE/bug-report.yml
21+
22+
name: Bug report
23+
description: Problems with the software
24+
title: "[Bug] "
25+
labels: ["bug"]
26+
body:
27+
- type: markdown
28+
attributes:
29+
value: |
30+
Thank you very much for your feedback!
31+
- type: checkboxes
32+
attributes:
33+
label: Search before asking
34+
description: >
35+
Please search [issues](https://github.com/alibaba/paimon-cpp/issues) to check if your issue has already been reported.
36+
options:
37+
- label: >
38+
I searched in the [issues](https://github.com/alibaba/paimon-cpp/issues) and found nothing similar.
39+
required: true
40+
- type: textarea
41+
attributes:
42+
label: Paimon-cpp version
43+
description: >
44+
Please provide the version of Paimon-cpp you are using. If you are using the master branch, please provide the commit id.
45+
validations:
46+
required: true
47+
- type: textarea
48+
attributes:
49+
label: Minimal reproduce step
50+
description: Please try to give reproducing steps to facilitate quick location of the problem.
51+
validations:
52+
required: true
53+
- type: textarea
54+
attributes:
55+
label: What doesn't meet your expectations?
56+
validations:
57+
required: true
58+
- type: textarea
59+
attributes:
60+
label: Anything else?
61+
- type: checkboxes
62+
attributes:
63+
label: Are you willing to submit a PR?
64+
description: >
65+
We look forward to the community of developers or users helping solve Paimon-cpp problems together. If you are willing to submit a PR to fix this problem, please check the box.
66+
options:
67+
- label: I'm willing to submit a PR!
68+
- type: markdown
69+
attributes:
70+
value: "Thanks for completing our form!"

‎.github/ISSUE_TEMPLATE/config.yaml‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Copyright 2025-present Alibaba Inc.
2+
#
3+
# Licensed under the Apache License, Version 2.0 (the "License");
4+
# you may not use this file except in compliance with the License.
5+
# You may obtain a copy of the License at
6+
#
7+
# http://www.apache.org/licenses/LICENSE-2.0
8+
#
9+
# Unless required by applicable law or agreed to in writing, software
10+
# distributed under the License is distributed on an "AS IS" BASIS,
11+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
# See the License for the specific language governing permissions and
13+
# limitations under the License.
14+
15+
blank_issues_enabled: false

‎.github/ISSUE_TEMPLATE/feature.yaml‎

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
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, software
13+
# distributed under the License is distributed on an "AS IS" BASIS,
14+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
# See the License for the specific language governing permissions and
16+
# limitations under the License.
17+
################################################################################
18+
19+
# Adapted from Apache Paimon
20+
# https://github.com/apache/paimon/blob/master/.github/ISSUE_TEMPLATE/feature.yml
21+
22+
name: Feature
23+
description: Add new feature, improve code, and more
24+
title: "[Feature] "
25+
labels: [ "enhancement" ]
26+
body:
27+
- type: markdown
28+
attributes:
29+
value: |
30+
Thank you very much for your feature proposal!
31+
- type: checkboxes
32+
attributes:
33+
label: Search before asking
34+
description: >
35+
Please search [issues](https://github.com/alibaba/paimon-cpp/issues) to check if your issue has already been reported.
36+
options:
37+
- label: >
38+
I searched in the [issues](https://github.com/alibaba/paimon-cpp/issues) and found nothing similar.
39+
required: true
40+
- type: textarea
41+
attributes:
42+
label: Motivation
43+
description: Describe the motivations for this feature, like how it fixes the problem you meet.
44+
validations:
45+
required: true
46+
- type: textarea
47+
attributes:
48+
label: Solution
49+
description: Describe the proposed solution and add related materials like links if any.
50+
- type: textarea
51+
attributes:
52+
label: Anything else?
53+
- type: checkboxes
54+
attributes:
55+
label: Are you willing to submit a PR?
56+
description: >
57+
We look forward to the community of developers or users helping develop Paimon-cpp features together. If you are willing to submit a PR to implement the feature, please check the box.
58+
options:
59+
- label: I'm willing to submit a PR!
60+
- type: markdown
61+
attributes:
62+
value: "Thanks for completing our form!"

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
<!-- Please specify the module before the PR name: feat: ... or fix: ... -->
2+
3+
### Purpose
4+
5+
<!-- Linking this pull request to the issue -->
6+
Linked issue: close #xxx
7+
8+
<!-- What is the purpose of the change -->
9+
10+
### Tests
11+
12+
<!-- List UT and IT cases to verify this change -->
13+
14+
### API and Format
15+
16+
<!-- Does this change affect API in include dir or storage format or protocol -->
17+
18+
### Documentation
19+
20+
<!-- Does this change introduce a new feature -->

0 commit comments

Comments
 (0)