Skip to content

Commit 758f0e8

Browse files
mxsmmxsm
authored
[ISSUE #150]🚀Update ISSUE TEMPLATE and add some markdown doc (#153)
* [ISSUE #150] 📝Add rocketmq-rust icon * [ISSUE #150]📝Update issue template * [ISSUE #150] 🚀Add CHANGELOG.md * [ISSUE #150]🚀Add CODE_OF_CONDUCT.md * [ISSUE #150]🚀Add CONTRIBUTING.md * [ISSUE #150]🚀Update ISSUE TEMPLATE and some markdown doc
1 parent 64920af commit 758f0e8

11 files changed

+412
-74
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md

-44
This file was deleted.

‎.github/ISSUE_TEMPLATE/bug_report.yml

+110
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,110 @@
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] Bug title "
20+
description: Create a report to help us identify any unintended flaws, errors, or faults.
21+
body:
22+
- type: checkboxes
23+
attributes:
24+
label: Before Creating the Bug Report
25+
options:
26+
- label: >
27+
I found a bug, not just asking a question, which should be created in [GitHub Discussions](https://github.com/mxsm/rocketmq-rust/discussions).
28+
required: true
29+
- label: >
30+
I have searched the [GitHub Issues](https://github.com/mxsm/rocketmq-rust/issues) and [GitHub Discussions](https://github.com/mxsm/rocketmq-rust/discussions) of this repository and believe that this is not a duplicate.
31+
required: true
32+
- label: >
33+
I have confirmed that this bug belongs to the current repository, not other repositories of RocketMQ.
34+
required: true
35+
36+
- type: textarea
37+
attributes:
38+
label: Runtime platform environment
39+
description: Describe the runtime platform environment.
40+
placeholder: >
41+
OS: (e.g., "Ubuntu 20.04")
42+
OS: (e.g., "Windows Server 2019")
43+
validations:
44+
required: false
45+
46+
- type: textarea
47+
attributes:
48+
label: RocketMQ Rust version
49+
description: Describe the RocketMQ Rust version.
50+
placeholder: >
51+
branch: (e.g master)
52+
version: (e.g. 0.1.0)
53+
Git commit id: (e.g. 37b9bfa7f4516b8da69e91ec0cb288b9724262a2)
54+
validations:
55+
required: false
56+
57+
- type: textarea
58+
attributes:
59+
label: Rust Version
60+
description: Run or Compiler version.
61+
placeholder: >
62+
Compiler: (e.g., "1.75.0")
63+
OS: (e.g., "Ubuntu 20.04")
64+
validations:
65+
required: false
66+
67+
- type: textarea
68+
attributes:
69+
label: Describe the Bug
70+
description: Describe what happened.
71+
placeholder: >
72+
A clear and concise description of what the bug is.
73+
validations:
74+
required: false
75+
76+
- type: textarea
77+
attributes:
78+
label: Steps to Reproduce
79+
description: Describe the steps to reproduce the bug here.
80+
placeholder: >
81+
If possible, provide a recipe for reproducing the error.
82+
validations:
83+
required: false
84+
85+
- type: textarea
86+
attributes:
87+
label: What Did You Expect to See?
88+
description: You expect to see result.
89+
placeholder: >
90+
A clear and concise description of what you expected to see.
91+
validations:
92+
required: false
93+
94+
- type: textarea
95+
attributes:
96+
label: What Did You See Instead?
97+
description: You instead to see result.
98+
placeholder: >
99+
A clear and concise description of what you saw instead.
100+
validations:
101+
required: false
102+
103+
- type: textarea
104+
attributes:
105+
label: Additional Context
106+
description: Additional context.
107+
placeholder: >
108+
Add any other context about the problem here.
109+
validations:
110+
required: false

‎.github/ISSUE_TEMPLATE/config.yml

+23-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,23 @@
1-
blank_issues_enabled: true
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+
19+
blank_issues_enabled: false
20+
contact_links:
21+
- name: Ask Question
22+
url: https://github.com/mxsm/rocketmq-rust/discussions
23+
about: Please go to GitHub Disccusions to ask questions

‎.github/ISSUE_TEMPLATE/doc.yml

+55
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
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: Documentation Related
19+
title: "[Doc] Documentation Related "
20+
description: I find some issues related to the documentation.
21+
labels: [ "documentation" ]
22+
body:
23+
- type: checkboxes
24+
attributes:
25+
label: Search before creation
26+
description: >
27+
Please make sure to search in the [issues](https://github.com/mxsm/rocketmq-rust/issues)
28+
first to see whether the same issue was reported already.
29+
options:
30+
- label: >
31+
I had searched in the [issues](https://github.com/mxsm/rocketmq-rust/issues) and found
32+
no similar issues.
33+
required: true
34+
35+
- type: textarea
36+
attributes:
37+
label: Documentation Related
38+
description: Describe the suggestion about document.
39+
placeholder: >
40+
e.g There is a typo
41+
validations:
42+
required: false
43+
44+
- type: checkboxes
45+
attributes:
46+
label: Are you willing to submit PR?
47+
description: >
48+
This is absolutely not required, but we are happy to guide you in the contribution process
49+
especially if you already have a good understanding of how to implement the fix.
50+
options:
51+
- label: Yes I am willing to submit a PR!
52+
53+
- type: markdown
54+
attributes:
55+
value: "Thanks for completing our form!"

‎.github/ISSUE_TEMPLATE/enhancement_request.yml

+75
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
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+
19+
name: Enhancement Request
20+
title: "[Enhancement] Enhancement title"
21+
description: Suggest an enhancement for this project
22+
labels: [ "enhancement" ]
23+
body:
24+
- type: checkboxes
25+
attributes:
26+
label: Before Creating the Enhancement Request
27+
description: >
28+
Most of issues should be classified as bug or feature request. An issue should be considered as an enhancement when it proposes improvements to
29+
existing functionality or user experience, without necessarily introducing new features or fixing existing bugs.
30+
options:
31+
- label: >
32+
I have confirmed that this should be classified as an enhancement rather than a bug/feature.
33+
required: false
34+
35+
- type: textarea
36+
attributes:
37+
label: Summary
38+
placeholder: >
39+
A clear and concise description of the enhancement you would like to see in the project.
40+
validations:
41+
required: false
42+
43+
- type: textarea
44+
attributes:
45+
label: Motivation
46+
placeholder: >
47+
Explain why you believe this enhancement is necessary, and how it benefits the project and community.
48+
Include any specific use cases that you have in mind.
49+
validations:
50+
required: false
51+
52+
- type: textarea
53+
attributes:
54+
label: Describe the Solution You'd Like
55+
placeholder: >
56+
Describe the enhancement you propose, detailing the change and implementation steps involved.
57+
If you have multiple solutions, please list them separately.
58+
validations:
59+
required: false
60+
61+
- type: textarea
62+
attributes:
63+
label: Describe Alternatives You've Considered
64+
placeholder: >
65+
List any alternative enhancements or implementations you have considered, and explain why they may not be as effective or appropriate.
66+
validations:
67+
required: false
68+
69+
- type: textarea
70+
attributes:
71+
label: Additional Context
72+
placeholder: >
73+
Add any relevant context, screenshots, prototypes, or other supplementary information to help illustrate the enhancement.
74+
validations:
75+
required: false

‎.github/ISSUE_TEMPLATE/feature_request.md

-28
This file was deleted.

0 commit comments

Comments
 (0)