Skip to content

Commit ab23967

Browse files
lsy357lsy357
authored
[refactor] [workflow] use yaml instead of md with issue template (#36)
1 parent 62c1b62 commit ab23967

6 files changed

Lines changed: 277 additions & 66 deletions

File tree

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 0 additions & 40 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 138 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,138 @@
1+
name: 🐛 Bug Report
2+
description: Create a report to help us improve Coze Loop
3+
title: "[BUG] "
4+
labels: ["bug", "needs-triage"]
5+
assignees: []
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Thanks for taking the time to fill out this bug report!
11+
12+
**Note:** All bug reports must be submitted in English.
13+
14+
- type: checkboxes
15+
id: terms
16+
attributes:
17+
label: "📋 CheckList"
18+
description: "Please confirm the following requirements:"
19+
options:
20+
- label: "I have searched existing issues to avoid duplicates"
21+
required: true
22+
- label: "I am using a recently maintained version of Coze Loop"
23+
required: true
24+
- label: "I have provided all required information"
25+
required: true
26+
- label: "I understand this is a bug report and not a feature request"
27+
required: true
28+
- label: "I have submitted this report in English (otherwise it will not be processed)"
29+
required: true
30+
31+
- type: textarea
32+
id: bug-description
33+
attributes:
34+
label: "🐛 Bug Description"
35+
description: "A clear and concise description of what the bug is."
36+
placeholder: "Describe the bug you encountered..."
37+
validations:
38+
required: true
39+
40+
- type: textarea
41+
id: reproduction-steps
42+
attributes:
43+
label: "🔄 Steps to Reproduce"
44+
description: "Please provide detailed steps to reproduce the issue."
45+
placeholder: |
46+
1. Go to '...'
47+
2. Click on '....'
48+
3. Scroll down to '....'
49+
4. See error
50+
validations:
51+
required: true
52+
53+
- type: textarea
54+
id: expected-behavior
55+
attributes:
56+
label: "✅ Expected Behavior"
57+
description: "A clear and concise description of what you expected to happen."
58+
placeholder: "Describe what you expected to happen..."
59+
validations:
60+
required: true
61+
62+
- type: textarea
63+
id: actual-behavior
64+
attributes:
65+
label: "❌ Actual Behavior"
66+
description: "A clear and concise description of what actually happened."
67+
placeholder: "Describe what actually happened..."
68+
validations:
69+
required: true
70+
71+
- type: dropdown
72+
id: severity
73+
attributes:
74+
label: "🚨 Severity"
75+
description: "How critical is this bug?"
76+
options:
77+
- "Critical - System crash or data loss"
78+
- "High - Major functionality broken"
79+
- "Medium - Minor functionality affected"
80+
- "Low - Cosmetic issue or minor inconvenience"
81+
validations:
82+
required: false
83+
84+
- type: dropdown
85+
id: component
86+
attributes:
87+
label: "🔧 Component"
88+
description: "Which component of Coze Loop is affected?"
89+
options:
90+
- "Prompt Development"
91+
- "Evaluation"
92+
- "Observation"
93+
- "Model Integration"
94+
- "Infrastructure"
95+
- "Documentation"
96+
- "Other"
97+
validations:
98+
required: false
99+
100+
- type: textarea
101+
id: environment
102+
attributes:
103+
label: "💻 Environment"
104+
description: "Please provide your environment details."
105+
placeholder: |
106+
**OS:** [e.g. macOS 14.0, Ubuntu 22.04, Windows 11]
107+
**Go Version:** [e.g. go version go1.23.4 darwin/amd64]
108+
**Docker Version:** [e.g. Docker version 24.0.7]
109+
**Browser:** [e.g. Chrome 120.0, Firefox 121.0] (if applicable)
110+
**Coze Loop Version:** [e.g. v1.0.0, commit hash, or "latest"]
111+
**Model Configuration:** [e.g. OpenAI GPT-4, Volcengine Ark]
112+
validations:
113+
required: false
114+
115+
- type: textarea
116+
id: go-env
117+
attributes:
118+
label: "🔧 Go Environment"
119+
description: "Output of `go env` command"
120+
placeholder: "Paste the output of 'go env' here..."
121+
122+
- type: textarea
123+
id: logs
124+
attributes:
125+
label: "📋 Logs"
126+
description: "Please provide relevant logs, error messages, or stack traces."
127+
placeholder: |
128+
```
129+
[Paste logs here]
130+
```
131+
render: shell
132+
133+
- type: textarea
134+
id: additional-context
135+
attributes:
136+
label: "📝 Additional Context"
137+
description: "Add any other context about the problem here."
138+
placeholder: "Any additional information that might be helpful..."

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: 🔧 Question/Help
4+
url: https://github.com/coze-dev/coze-loop/discussions
5+
about: Ask questions or get help from the community

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 0 additions & 24 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 131 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,131 @@
1+
name: ✨ Feature Request
2+
description: Suggest an idea for Coze Loop
3+
title: "[FEATURE] "
4+
labels: ["enhancement", "needs-triage"]
5+
assignees: []
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Thanks for taking the time to suggest a feature for Coze Loop!
11+
12+
**Note:** All feature requests must be submitted in English.
13+
14+
- type: checkboxes
15+
id: terms
16+
attributes:
17+
label: "📋 Please ensure that:"
18+
description: "Please confirm the following requirements:"
19+
options:
20+
- label: "I have searched existing issues to avoid duplicates"
21+
required: true
22+
- label: "I have provided a clear problem statement and solution"
23+
required: true
24+
- label: "I understand this is a feature request and not a bug report"
25+
required: true
26+
- label: "I am willing to help implement this feature if needed"
27+
required: false
28+
- label: "I have submitted this feature request in English (otherwise it will not be processed)"
29+
required: true
30+
31+
- type: textarea
32+
id: problem-description
33+
attributes:
34+
label: "🎯 Problem Statement"
35+
description: "Is your feature request related to a problem? Please describe."
36+
placeholder: "I'm always frustrated when [...]"
37+
validations:
38+
required: true
39+
40+
- type: textarea
41+
id: solution-description
42+
attributes:
43+
label: "💡 Proposed Solution"
44+
description: "A clear and concise description of what you want to happen."
45+
placeholder: "Describe the solution you'd like to see implemented..."
46+
validations:
47+
required: true
48+
49+
- type: textarea
50+
id: use-cases
51+
attributes:
52+
label: "📋 Use Cases"
53+
description: "Describe specific use cases where this feature would be beneficial."
54+
placeholder: |
55+
- Use case 1: [Description]
56+
- Use case 2: [Description]
57+
- Use case 3: [Description]
58+
validations:
59+
required: true
60+
61+
- type: dropdown
62+
id: priority
63+
attributes:
64+
label: "⚡ Priority"
65+
description: "How important is this feature to you?"
66+
options:
67+
- "Critical - Essential for my workflow"
68+
- "High - Would significantly improve my experience"
69+
- "Medium - Nice to have"
70+
- "Low - Minor improvement"
71+
validations:
72+
required: false
73+
74+
- type: dropdown
75+
id: component
76+
attributes:
77+
label: "🔧 Component"
78+
description: "Which component of Coze Loop would this feature affect?"
79+
options:
80+
- "Prompt Development"
81+
- "Evaluation"
82+
- "Observation"
83+
- "Model Integration"
84+
- "Infrastructure"
85+
- "Documentation"
86+
- "Other"
87+
validations:
88+
required: false
89+
90+
- type: textarea
91+
id: alternatives
92+
attributes:
93+
label: "🔄 Alternatives Considered"
94+
description: "A clear and concise description of any alternative solutions or features you've considered."
95+
placeholder: "Describe any alternative solutions you've considered..."
96+
97+
- type: textarea
98+
id: mockups
99+
attributes:
100+
label: "🎨 Mockups/Designs"
101+
description: "If applicable, add mockups, wireframes, or design concepts."
102+
placeholder: "Add mockups, screenshots, or design concepts here..."
103+
104+
- type: textarea
105+
id: technical-details
106+
attributes:
107+
label: "⚙️ Technical Details"
108+
description: "If you have technical implementation ideas, please share them."
109+
placeholder: |
110+
- API changes needed
111+
- Database schema changes
112+
- Frontend components
113+
- Backend services
114+
- Integration points
115+
116+
- type: textarea
117+
id: acceptance-criteria
118+
attributes:
119+
label: "✅ Acceptance Criteria"
120+
description: "What would make this feature complete? List specific criteria."
121+
placeholder: |
122+
- [ ] Criterion 1
123+
- [ ] Criterion 2
124+
- [ ] Criterion 3
125+
126+
- type: textarea
127+
id: additional-context
128+
attributes:
129+
label: "📝 Additional Context"
130+
description: "Add any other context or screenshots about the feature request here."
131+
placeholder: "Any additional information that might be helpful..."

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,13 +17,14 @@ chore: Changes to the build process or auxiliary tools and libraries such as doc
1717

1818
#### Check the PR title.
1919
<!--
20-
The description of the title will be attached in Release Notes,
20+
The description of the title will be attached in Release Notes,
2121
so please describe it from user-oriented, what this PR does / why we need it.
2222
Please check your PR title with the below requirements:
2323
-->
2424
- [ ] This PR title match the format: \[\<type\>\]\[\<scope\>\]: \<description\>. For example: \[fix\]\[backend\] flaky fix
2525
- [ ] The description of this PR title is user-oriented and clear enough for others to understand.
2626
- [ ] Add documentation if the current PR requires user awareness at the usage level.
27+
- [ ] This PR is written in English. PRs not in English will not be reviewed.
2728

2829

2930
#### (Optional) Translate the PR title into Chinese.
@@ -34,7 +35,7 @@ Please check your PR title with the below requirements:
3435
Provide more detailed info for review(e.g., it's recommended to provide perf data if this is a perf type PR).
3536
-->
3637
en:
37-
zh(optional):
38+
zh(optional):
3839

3940

4041
#### (Optional) Which issue(s) this PR fixes:

0 commit comments

Comments
 (0)