Skip to content

Commit 4099f62

Browse files
authored
Merge pull request #26 from TheCodeVerseHub/yc45
New issue template
2 parents d516f14 + 91f7da8 commit 4099f62

1 file changed

Lines changed: 82 additions & 0 deletions

File tree

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
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 create a well-scoped, beginner-friendly issue.
11+
12+
Tips:
13+
- Keep the scope small (1 PR).
14+
- Add links to relevant files/lines or existing issues.
15+
- Include clear acceptance criteria.
16+
17+
- type: textarea
18+
id: summary
19+
attributes:
20+
label: Summary
21+
description: One or two sentences describing what needs to be done.
22+
placeholder: Add a missing command to the help output.
23+
validations:
24+
required: true
25+
26+
- type: textarea
27+
id: context
28+
attributes:
29+
label: Context
30+
description: Why is this needed? Link related issues/PRs or docs.
31+
placeholder: |
32+
- Related issue(s): #
33+
- Relevant docs/notes:
34+
validations:
35+
required: false
36+
37+
- type: textarea
38+
id: suggested-approach
39+
attributes:
40+
label: Suggested approach
41+
description: A simple step-by-step approach a new contributor can follow.
42+
placeholder: |
43+
1. Locate ...
44+
2. Update ...
45+
3. Add/adjust ...
46+
validations:
47+
required: false
48+
49+
- type: textarea
50+
id: acceptance-criteria
51+
attributes:
52+
label: Acceptance criteria
53+
description: What must be true for this issue to be considered done?
54+
placeholder: |
55+
- [ ] ...
56+
- [ ] ...
57+
validations:
58+
required: true
59+
60+
- type: textarea
61+
id: files-to-look-at
62+
attributes:
63+
label: Files / areas to look at
64+
description: Point to where the change likely needs to happen.
65+
placeholder: |
66+
- cogs/...
67+
- utils/...
68+
- docs/...
69+
validations:
70+
required: false
71+
72+
- type: checkboxes
73+
id: readiness
74+
attributes:
75+
label: Checklist
76+
options:
77+
- label: The scope is small enough for a first contribution.
78+
required: true
79+
- label: Acceptance criteria are clear and testable.
80+
required: true
81+
- label: Relevant pointers/links are included.
82+
required: false

0 commit comments

Comments
 (0)