Skip to content

Commit dffc9fb

Browse files
committed
[github] Add issue template, pull request template and mvnw.
1 parent 9156505 commit dffc9fb

17 files changed

+882
-90
lines changed

.github/ISSUE_TEMPLATE/----feature-request.md

-20
This file was deleted.

.github/ISSUE_TEMPLATE/--ask-a-question.md

-22
This file was deleted.

.github/ISSUE_TEMPLATE/--bug-report.md

-24
This file was deleted.

.github/ISSUE_TEMPLATE/--development-task.md

-10
This file was deleted.
+59
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
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+
name: Ask Question
18+
description: Ask question and need help.
19+
title: "[Question][Module Name] Ask for question"
20+
labels: [ "question", "Waiting for reply" ]
21+
body:
22+
- type: markdown
23+
attributes:
24+
value: |
25+
For better global communication, Please write in English.
26+
27+
If you feel the description in English is not clear, then you can append description in Chinese, thanks!
28+
29+
- type: checkboxes
30+
attributes:
31+
label: Search before asking
32+
description: >
33+
Please make sure to search in the [issues](https://github.com/DTStack/chunjun/issues) first to see whether the same feature was requested already.
34+
options:
35+
- label: >
36+
I had searched in the [issues](https://github.com/DTStack/chunjun/issues) and found no similar question.
37+
- label: >
38+
I had googled my question but i didn't get any help.
39+
- label: >
40+
I had read the documentation: [ChunJun doc](https://dtstack.github.io/chunjun) but it didn't help me.
41+
42+
- type: textarea
43+
attributes:
44+
label: Description
45+
description: A description what you want to know, or what kind of help do you want from us.
46+
47+
- type: checkboxes
48+
attributes:
49+
label: Code of Conduct
50+
description: |
51+
The Code of Conduct helps create a safe space for everyone. We require that everyone agrees to it.
52+
options:
53+
- label: |
54+
I agree to follow this project's [Code of Conduct](https://www.apache.org/foundation/policies/conduct)
55+
required: true
56+
57+
- type: markdown
58+
attributes:
59+
value: "Thanks for completing our form!"

.github/ISSUE_TEMPLATE/bug-report.yml

+128
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
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+
name: Bug report
19+
title: "[Bug] [Module Name] Bug title "
20+
description: Problems and issues with code of this project.
21+
labels: [ "bug", "Waiting for reply" ]
22+
body:
23+
- type: markdown
24+
attributes:
25+
value: >
26+
Please make sure what you are reporting is indeed a bug with reproducible steps, if you want to ask questions
27+
or share ideas, you can head to our
28+
[Discussions](https://github.com/DTStack/chunjun/discussions) tab, if you want to get more information of this
29+
project, you can visit the [official website](https://dtstack.github.io/chunjun/).
30+
31+
For better global communication, Please write in English.
32+
33+
If you feel the description in English is not clear, then you can append description in Chinese, thanks!
34+
35+
- type: checkboxes
36+
attributes:
37+
label: Search before asking
38+
description: >
39+
Please make sure to search in the [issues](https://github.com/DTStack/chunjun/issues)
40+
first to see whether the same issue was reported already.
41+
options:
42+
- label: >
43+
I had searched in the [issues](https://github.com/DTStack/chunjun/issues) and found
44+
no similar issues.
45+
required: true
46+
47+
- type: textarea
48+
attributes:
49+
label: What happened
50+
description: Describe what happened.
51+
placeholder: >
52+
Please provide the context in which the problem occurred and explain what happened.
53+
validations:
54+
required: true
55+
56+
- type: textarea
57+
attributes:
58+
label: What you expected to happen
59+
description: What do you think went wrong?
60+
placeholder: >
61+
Please explain why you think the behaviour is erroneous. It is extremely helpful if you copy and paste
62+
the fragment of logs showing the exact error messages or wrong behaviour.
63+
You can include files by dragging and dropping them here.
64+
65+
**NOTE**: It's better copy and paste texts rather than taking screenshots of them for easy future search.
66+
validations:
67+
required: true
68+
69+
- type: textarea
70+
attributes:
71+
label: How to reproduce
72+
description: >
73+
What should we do to reproduce the problem? If you are not able to provide a reproducible case,
74+
please open a [Discussion](https://github.com/DTStack/chunjun/discussions) instead.
75+
placeholder: >
76+
Please make sure you provide a reproducible step-by-step case of how to reproduce the problem
77+
as minimally and precisely as possible. Keep in mind we do not have access to your deployment.
78+
Remember that non-reproducible issues will be closed! Opening a discussion is recommended as a
79+
first step.
80+
validations:
81+
required: true
82+
83+
- type: textarea
84+
attributes:
85+
label: Anything else
86+
description: Anything else we need to know?
87+
placeholder: >
88+
How often does this problem occur? (Once? Every time? Only when certain conditions are met?)
89+
Any relevant logs to include? Put them here inside fenced
90+
``` ``` blocks or inside a collapsable details tag if it's too long:
91+
<details><summary>x.log</summary> lots of stuff </details>
92+
93+
- type: dropdown
94+
id: version
95+
attributes:
96+
label: Version
97+
description: >
98+
Which version of ChunJun are you using? We only accept bugs report from the LTS projects.
99+
options:
100+
- master
101+
- 1.12_release
102+
- 1.10_release
103+
validations:
104+
required: true
105+
106+
- type: checkboxes
107+
attributes:
108+
label: Are you willing to submit PR?
109+
description: >
110+
This is absolutely not required, but we are happy to guide you in the contribution process
111+
especially if you already have a good understanding of how to implement the fix.
112+
We love to bring new contributors in.
113+
options:
114+
- label: Yes I am willing to submit a PR!
115+
116+
- type: checkboxes
117+
attributes:
118+
label: Code of Conduct
119+
description: |
120+
The Code of Conduct helps create a safe space for everyone. We require that everyone agrees to it.
121+
options:
122+
- label: |
123+
I agree to follow this project's [Code of Conduct](https://www.apache.org/foundation/policies/conduct)
124+
required: true
125+
126+
- type: markdown
127+
attributes:
128+
value: "Thanks for completing our form!"
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
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+
name: Documentation Related
18+
description: Suggest an improvement or report a bug for this project's Documentation.
19+
title: "[Doc][Module Name] Documentation bug or improvement"
20+
labels: [ "document", "Waiting for reply" ]
21+
body:
22+
- type: markdown
23+
attributes:
24+
value: |
25+
Through the [official website](https://dtstack.github.io/chunjun/), you can find all the documents about Chunjun.
26+
27+
For better global communication, Please write in English.
28+
29+
If you feel the description in English is not clear, then you can append description in Chinese, thanks!
30+
31+
- type: checkboxes
32+
attributes:
33+
label: Search before asking
34+
description: >
35+
Please make sure to search in the [issues](https://github.com/DTStack/chunjun/issues) first to see whether the same feature was requested already.
36+
options:
37+
- label: >
38+
I had searched in the [issues](https://github.com/DTStack/chunjun/issues) and found no similar document issue.
39+
required: true
40+
41+
- type: textarea
42+
attributes:
43+
label: Description
44+
description: A short description what error your find in our document, or what document we miss.
45+
46+
- type: textarea
47+
attributes:
48+
label: Documentation Links
49+
description: Copy and paste one or more links of this documentation issue.
50+
51+
- type: checkboxes
52+
attributes:
53+
label: Are you willing to submit a PR?
54+
description: >
55+
This is absolutely not required, but we are happy to guide you in the contribution process
56+
especially if you already have a good understanding of how to implement the improvement.
57+
We love to bring new contributors in.
58+
options:
59+
- label: Yes I am willing to submit a PR!
60+
61+
- type: checkboxes
62+
attributes:
63+
label: Code of Conduct
64+
description: |
65+
The Code of Conduct helps create a safe space for everyone. We require that everyone agrees to it.
66+
options:
67+
- label: |
68+
I agree to follow this project's [Code of Conduct](https://www.apache.org/foundation/policies/conduct)
69+
required: true
70+
71+
- type: markdown
72+
attributes:
73+
value: "Thanks for completing our form!"

0 commit comments

Comments
 (0)