Skip to content

Commit 12036ed

Browse files
prosdevprosdev
committed
chore: add GitHub issue templates for standardized ticket creation
- Add Epic template with goals, acceptance criteria, and definition of done - Add Story template with branch, priority, estimate, and technical requirements - Add Task template for technical implementation tasks - Add Feature template for feature requests - Add Bug template with reproduction steps and expected behavior - Configure blank issues and documentation links
1 parent 604c7fd commit 12036ed

File tree

6 files changed

+449
-0
lines changed

6 files changed

+449
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug.yml‎

Lines changed: 102 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
name: Bug
2+
description: Report a bug to help us improve
3+
title: "Bug: "
4+
labels: ["type: bug", "needs-triage"]
5+
assignees: []
6+
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
Thanks for reporting a bug! Please provide as much detail as possible to help us fix it quickly.
12+
13+
- type: input
14+
id: branch
15+
attributes:
16+
label: Branch
17+
description: The branch name for the fix (e.g., fix/bug-description)
18+
placeholder: "fix/bug-name"
19+
validations:
20+
required: true
21+
22+
- type: dropdown
23+
id: priority
24+
attributes:
25+
label: Priority
26+
description: How severe is this bug?
27+
options:
28+
- Critical (System unusable)
29+
- High (Major functionality broken)
30+
- Medium (Significant issue)
31+
- Low (Minor issue)
32+
- Trivial (Cosmetic issue)
33+
default: 2
34+
validations:
35+
required: true
36+
37+
- type: input
38+
id: estimate
39+
attributes:
40+
label: Estimate
41+
description: The estimated time to fix this bug (e.g., 1 day)
42+
placeholder: "2 days"
43+
validations:
44+
required: true
45+
46+
- type: textarea
47+
id: description
48+
attributes:
49+
label: Description
50+
description: A clear and concise description of the bug
51+
placeholder: "When I..."
52+
validations:
53+
required: true
54+
55+
- type: textarea
56+
id: reproduction
57+
attributes:
58+
label: Steps to Reproduce
59+
description: How can we reproduce this issue?
60+
placeholder: |
61+
1. Go to '...'
62+
2. Click on '....'
63+
3. Scroll down to '....'
64+
4. See error
65+
validations:
66+
required: true
67+
68+
- type: textarea
69+
id: expected
70+
attributes:
71+
label: Expected Behavior
72+
description: What did you expect to happen?
73+
placeholder: "I expected..."
74+
validations:
75+
required: true
76+
77+
- type: textarea
78+
id: actual
79+
attributes:
80+
label: Actual Behavior
81+
description: What actually happened?
82+
placeholder: "Instead, I saw..."
83+
validations:
84+
required: true
85+
86+
- type: textarea
87+
id: fix-approach
88+
attributes:
89+
label: Proposed Fix
90+
description: If you have ideas on how to fix this bug, please share them
91+
placeholder: "I think this could be fixed by..."
92+
validations:
93+
required: false
94+
95+
- type: textarea
96+
id: additional
97+
attributes:
98+
label: Additional Information
99+
description: Any other context about the bug (environment, logs, screenshots)
100+
placeholder: "Node.js version: 22.0.0\nOS: macOS 14.0\n..."
101+
validations:
102+
required: false

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: true
2+
contact_links:
3+
- name: Dev-Agent Documentation
4+
url: https://github.com/lytics/dev-agent/blob/main/docs/README.md
5+
about: Check the documentation before creating an issue.
6+
- name: Contribution Guidelines
7+
url: https://github.com/lytics/dev-agent/blob/main/CONTRIBUTING.md
8+
about: Please read the contribution guidelines before creating an issue.

‎.github/ISSUE_TEMPLATE/epic.yml‎

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
name: Epic
2+
description: A large body of work that can be broken down into smaller stories/tasks
3+
title: "Epic: "
4+
labels: ["type: epic", "needs-triage"]
5+
assignees: []
6+
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
Thanks for creating an Epic! Please provide as much detail as possible to help with planning.
12+
13+
- type: input
14+
id: epic-id
15+
attributes:
16+
label: Epic ID
17+
description: A unique identifier for this epic (e.g., CORE-1)
18+
placeholder: "CORE-1"
19+
validations:
20+
required: false
21+
22+
- type: textarea
23+
id: description
24+
attributes:
25+
label: Description
26+
description: Detailed description of this epic and what it aims to accomplish
27+
placeholder: "This epic focuses on..."
28+
validations:
29+
required: true
30+
31+
- type: textarea
32+
id: goals
33+
attributes:
34+
label: Goals
35+
description: List the primary goals of this epic
36+
placeholder: |
37+
1. Implement...
38+
2. Integrate...
39+
3. Ensure...
40+
validations:
41+
required: true
42+
43+
- type: textarea
44+
id: acceptance-criteria
45+
attributes:
46+
label: Acceptance Criteria
47+
description: List the criteria that must be met for this epic to be considered complete
48+
placeholder: |
49+
- [ ] All components...
50+
- [ ] System correctly...
51+
- [ ] Documentation is...
52+
validations:
53+
required: true
54+
55+
- type: textarea
56+
id: definition-of-done
57+
attributes:
58+
label: Definition of Done
59+
description: Specific requirements that signify completion of this epic
60+
placeholder: |
61+
- [ ] All code passes linting and formatting
62+
- [ ] Test coverage is at least 80%
63+
- [ ] Documentation is complete
64+
- [ ] All sub-tasks are completed
65+
validations:
66+
required: true
67+
68+
- type: dropdown
69+
id: priority
70+
attributes:
71+
label: Priority
72+
description: The priority level for this epic
73+
options:
74+
- Highest
75+
- High
76+
- Medium
77+
- Low
78+
- Lowest
79+
default: 2
80+
validations:
81+
required: true

‎.github/ISSUE_TEMPLATE/feature.yml‎

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
name: Feature
2+
description: A new feature request
3+
title: "Feature: "
4+
labels: ["type: feature", "needs-triage"]
5+
assignees: []
6+
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
Thanks for suggesting a new feature! Please provide as much detail as possible to help us understand your idea.
12+
13+
- type: input
14+
id: branch
15+
attributes:
16+
label: Branch
17+
description: The branch name for this feature (e.g., feat/new-feature)
18+
placeholder: "feat/feature-name"
19+
validations:
20+
required: true
21+
22+
- type: dropdown
23+
id: priority
24+
attributes:
25+
label: Priority
26+
description: The priority level for this feature
27+
options:
28+
- Highest
29+
- High
30+
- Medium
31+
- Low
32+
- Lowest
33+
default: 2
34+
validations:
35+
required: true
36+
37+
- type: input
38+
id: estimate
39+
attributes:
40+
label: Estimate
41+
description: The estimated time to implement this feature (e.g., 5 days)
42+
placeholder: "5 days"
43+
validations:
44+
required: true
45+
46+
- type: input
47+
id: parent-epic
48+
attributes:
49+
label: Parent Epic
50+
description: The parent epic this feature belongs to, if any (e.g., #123)
51+
placeholder: "#123"
52+
validations:
53+
required: false
54+
55+
- type: textarea
56+
id: description
57+
attributes:
58+
label: Description
59+
description: Detailed description of the feature and what problem it solves
60+
placeholder: "This feature will provide..."
61+
validations:
62+
required: true
63+
64+
- type: textarea
65+
id: acceptance-criteria
66+
attributes:
67+
label: Acceptance Criteria
68+
description: List the criteria that must be met for this feature to be considered complete
69+
placeholder: |
70+
- [ ] Feature supports...
71+
- [ ] UI includes...
72+
- [ ] Performance meets...
73+
validations:
74+
required: true
75+
76+
- type: textarea
77+
id: technical-requirements
78+
attributes:
79+
label: Technical Requirements
80+
description: Technical details and requirements for implementation
81+
placeholder: |
82+
- Use React for UI components
83+
- Implement caching for improved performance
84+
- Follow existing code patterns
85+
validations:
86+
required: true

‎.github/ISSUE_TEMPLATE/story.yml‎

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
name: Story
2+
description: A user story describing functionality from the user's perspective
3+
title: ""
4+
labels: ["type: story", "needs-triage"]
5+
assignees: []
6+
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
Thanks for creating a Story! Please provide as much detail as possible to help with implementation.
12+
13+
- type: input
14+
id: branch
15+
attributes:
16+
label: Branch
17+
description: The branch name for this story (e.g., feat/repository-scanner)
18+
placeholder: "feat/feature-name"
19+
validations:
20+
required: true
21+
22+
- type: dropdown
23+
id: priority
24+
attributes:
25+
label: Priority
26+
description: The priority level for this story
27+
options:
28+
- Highest
29+
- High
30+
- Medium
31+
- Low
32+
- Lowest
33+
default: 2
34+
validations:
35+
required: true
36+
37+
- type: input
38+
id: estimate
39+
attributes:
40+
label: Estimate
41+
description: The estimated time to complete this story (e.g., 2 days)
42+
placeholder: "3 days"
43+
validations:
44+
required: true
45+
46+
- type: input
47+
id: parent-epic
48+
attributes:
49+
label: Parent Epic
50+
description: The parent epic this story belongs to (e.g., #123)
51+
placeholder: "#123"
52+
validations:
53+
required: true
54+
55+
- type: textarea
56+
id: description
57+
attributes:
58+
label: Description
59+
description: Detailed description of this story and what it aims to accomplish
60+
placeholder: "Implement a..."
61+
validations:
62+
required: true
63+
64+
- type: textarea
65+
id: acceptance-criteria
66+
attributes:
67+
label: Acceptance Criteria
68+
description: List the criteria that must be met for this story to be considered complete
69+
placeholder: |
70+
- [ ] System correctly...
71+
- [ ] Integration with...
72+
- [ ] Error handling for...
73+
validations:
74+
required: true
75+
76+
- type: textarea
77+
id: technical-requirements
78+
attributes:
79+
label: Technical Requirements
80+
description: Technical details and requirements for implementation
81+
placeholder: |
82+
- Use TypeScript Compiler API for parsing
83+
- Implement caching mechanism
84+
- Create utility functions for...
85+
validations:
86+
required: true

0 commit comments

Comments
 (0)