Skip to content

Commit ef69746

Browse files
authored
Merge pull request #16 from TheCodeVerseHub/yc45
more issues
2 parents 858ba22 + c9cd5a1 commit ef69746

4 files changed

Lines changed: 194 additions & 0 deletions

File tree

.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: true
2+
contact_links:
3+
- name: Documentation
4+
url: https://github.com/TheCodeVerseHub/Miku#readme
5+
about: "Read the README and setup notes"
Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
name: "Enhancement"
2+
description: "Improve an existing feature (performance, UX, refactor, docs, etc.)"
3+
title: "[Enhancement]: "
4+
labels:
5+
- enhancement
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Use this for improvements to existing behavior (not brand-new features).
11+
12+
- type: textarea
13+
id: current
14+
attributes:
15+
label: Current behavior
16+
description: What does the bot do today?
17+
placeholder: "Currently..."
18+
validations:
19+
required: true
20+
21+
- type: textarea
22+
id: improvement
23+
attributes:
24+
label: Proposed improvement
25+
description: What should change?
26+
placeholder: "Change it so that..."
27+
validations:
28+
required: true
29+
30+
- type: textarea
31+
id: impact
32+
attributes:
33+
label: Impact / motivation
34+
description: Why is this valuable? Who benefits, and how?
35+
placeholder: "This helps because..."
36+
validations:
37+
required: false
38+
39+
- type: textarea
40+
id: alternatives
41+
attributes:
42+
label: Alternatives considered
43+
description: Other ways to approach this, if any.
44+
validations:
45+
required: false
46+
47+
- type: textarea
48+
id: additional
49+
attributes:
50+
label: Additional context
51+
description: Links, screenshots, code pointers, etc.
52+
validations:
53+
required: false
Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
name: "Good first issue"
2+
description: "Create a beginner-friendly task for new contributors"
3+
title: "[Good First Issue]: "
4+
labels:
5+
- good first issue
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Use this template to propose a small, well-scoped task that a new contributor can pick up.
11+
12+
- type: textarea
13+
id: summary
14+
attributes:
15+
label: Summary
16+
description: Briefly describe what needs to be done.
17+
placeholder: "Implement/adjust..."
18+
validations:
19+
required: true
20+
21+
- type: textarea
22+
id: context
23+
attributes:
24+
label: Context
25+
description: Why is this needed? Link related issues/PRs, docs, or code areas.
26+
placeholder: "Related to #..., see ..."
27+
validations:
28+
required: false
29+
30+
- type: textarea
31+
id: scope
32+
attributes:
33+
label: Scope (what's in / out)
34+
description: Keep this specific so it stays beginner-friendly.
35+
placeholder: |
36+
In:
37+
- ...
38+
39+
Out:
40+
- ...
41+
validations:
42+
required: true
43+
44+
- type: textarea
45+
id: acceptance
46+
attributes:
47+
label: Acceptance criteria
48+
description: Bullet list of what "done" means.
49+
placeholder: |
50+
- ...
51+
- ...
52+
validations:
53+
required: true
54+
55+
- type: textarea
56+
id: hints
57+
attributes:
58+
label: Suggested approach / hints
59+
description: Provide pointers (files, functions, commands) without over-prescribing.
60+
placeholder: |
61+
- Look at ...
62+
- Update ...
63+
- Run ...
64+
validations:
65+
required: false
66+
67+
- type: dropdown
68+
id: difficulty
69+
attributes:
70+
label: Estimated difficulty
71+
options:
72+
- "XS (≤ 1 hour)"
73+
- "S (1–3 hours)"
74+
- "M (half day)"
75+
validations:
76+
required: true
77+
78+
- type: checkboxes
79+
id: checklist
80+
attributes:
81+
label: Maintainer checklist
82+
options:
83+
- label: Task is well-scoped and actionable
84+
required: true
85+
- label: Has clear acceptance criteria
86+
required: true
87+
- label: Includes pointers to relevant code/docs
88+
required: false
89+
- label: Does not require private credentials/tokens
90+
required: false
Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
name: "Question"
2+
description: "Ask a question about setup, usage, or how something works"
3+
title: "[Question]: "
4+
labels:
5+
- question
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Please share enough context so maintainers/contributors can help efficiently.
11+
12+
- type: textarea
13+
id: question
14+
attributes:
15+
label: Your question
16+
description: What are you trying to understand or do?
17+
placeholder: "How do I..."
18+
validations:
19+
required: true
20+
21+
- type: textarea
22+
id: tried
23+
attributes:
24+
label: What you've tried
25+
description: Commands, configs, or docs you already checked.
26+
placeholder: "I tried..."
27+
validations:
28+
required: false
29+
30+
- type: input
31+
id: environment
32+
attributes:
33+
label: Environment
34+
description: OS + Python version (and anything else relevant).
35+
placeholder: "Ubuntu 22.04, Python 3.12"
36+
validations:
37+
required: false
38+
39+
- type: textarea
40+
id: logs
41+
attributes:
42+
label: Logs / output
43+
description: Paste relevant output (redact tokens/secrets).
44+
render: shell
45+
validations:
46+
required: false

0 commit comments

Comments
 (0)