Skip to content

Commit d1c6556

Browse files
committed
chore: add structured issue and PR templates
Issue Templates: - Bug Report: severity, component, steps to reproduce - Feature Request: problem statement, acceptance criteria - Tech Debt: impact analysis, migration plan PR Template: - Type of change checkboxes - Testing checklist - Deployment notes Config: - Disabled blank issues (must use templates) - Added links to discussions and docs
1 parent e0b5a70 commit d1c6556

5 files changed

Lines changed: 250 additions & 82 deletions

File tree

Lines changed: 55 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,70 +1,91 @@
1-
name: Bug Report
2-
description: Report a bug or issue with CodeIntel
1+
name: 🐛 Bug Report
2+
description: Something isn't working as expected
33
title: "[Bug]: "
4-
labels: ["bug", "needs-triage"]
4+
labels: ["bug", "triage"]
55
body:
66
- type: markdown
77
attributes:
88
value: |
9-
Thanks for taking the time to report a bug! Please fill out the details below.
9+
Thanks for taking the time to report a bug! Please fill out the sections below.
1010
1111
- type: textarea
12-
id: description
12+
id: summary
1313
attributes:
14-
label: Bug Description
15-
description: What happened? What did you expect to happen?
16-
placeholder: Describe the bug clearly and concisely
14+
label: Bug Summary
15+
description: A clear and concise description of what the bug is.
16+
placeholder: "When I do X, Y happens instead of Z"
1717
validations:
1818
required: true
1919

2020
- type: textarea
21-
id: reproduction
21+
id: reproduce
2222
attributes:
2323
label: Steps to Reproduce
2424
description: How can we reproduce this issue?
2525
placeholder: |
26-
1. Run command...
27-
2. Click on...
28-
3. See error...
26+
1. Go to '...'
27+
2. Click on '...'
28+
3. See error
2929
validations:
3030
required: true
3131

3232
- type: textarea
33-
id: logs
33+
id: expected
3434
attributes:
35-
label: Error Logs
36-
description: Paste any relevant error messages or logs
37-
render: shell
38-
placeholder: Paste logs here
35+
label: Expected Behavior
36+
description: What should happen?
37+
validations:
38+
required: true
39+
40+
- type: textarea
41+
id: actual
42+
attributes:
43+
label: Actual Behavior
44+
description: What actually happens? Include error messages, logs, screenshots.
45+
validations:
46+
required: true
3947

4048
- type: dropdown
4149
id: component
4250
attributes:
4351
label: Component
44-
description: Which part of CodeIntel is affected?
52+
description: Which part of the system is affected?
4553
options:
46-
- Backend API
47-
- Frontend UI
54+
- Backend - API
55+
- Backend - Indexing
56+
- Backend - Search
57+
- Backend - Dependency Analyzer
58+
- Backend - DNA Extractor
59+
- Frontend - Dashboard
60+
- Frontend - Search UI
4861
- MCP Server
49-
- Dependency Analysis
50-
- Search/Indexing
62+
- Infrastructure
5163
- Other
5264
validations:
5365
required: true
5466

55-
- type: input
56-
id: version
67+
- type: dropdown
68+
id: severity
5769
attributes:
58-
label: Version
59-
description: Which version of CodeIntel are you using?
60-
placeholder: v0.2.0 or commit SHA
70+
label: Severity
71+
description: How severe is this bug?
72+
options:
73+
- Critical - System unusable
74+
- High - Major feature broken
75+
- Medium - Feature impaired but workaround exists
76+
- Low - Minor issue
77+
validations:
78+
required: true
6179

6280
- type: textarea
63-
id: environment
81+
id: logs
6482
attributes:
65-
label: Environment
66-
description: System information
67-
placeholder: |
68-
- OS: macOS 14.1
69-
- Python: 3.11.5
70-
- Node: 20.10.0
83+
label: Relevant Logs
84+
description: Paste any relevant logs here (Railway logs, browser console, etc.)
85+
render: shell
86+
87+
- type: textarea
88+
id: context
89+
attributes:
90+
label: Additional Context
91+
description: Any other context, screenshots, or information.

.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: false
2+
contact_links:
3+
- name: 💬 Questions & Discussions
4+
url: https://github.com/OpenCodeIntel/opencodeintel/discussions
5+
about: Ask questions or start a discussion instead of opening an issue
6+
- name: 📖 Documentation
7+
url: https://github.com/OpenCodeIntel/opencodeintel#readme
8+
about: Check the README and docs before reporting issues
Lines changed: 55 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,59 +1,91 @@
1-
name: Feature Request
1+
name: Feature Request
22
description: Suggest a new feature or enhancement
33
title: "[Feature]: "
4-
labels: ["enhancement", "needs-discussion"]
4+
labels: ["enhancement", "triage"]
55
body:
66
- type: markdown
77
attributes:
88
value: |
9-
Have an idea to make CodeIntel better? We'd love to hear it!
9+
Thanks for suggesting a feature! Please describe your idea clearly.
1010
1111
- type: textarea
1212
id: problem
1313
attributes:
1414
label: Problem Statement
15-
description: What problem does this feature solve?
16-
placeholder: Describe the pain point or use case
15+
description: What problem does this feature solve? Who benefits?
16+
placeholder: "As a [user type], I want [goal] so that [benefit]"
1717
validations:
1818
required: true
1919

2020
- type: textarea
2121
id: solution
2222
attributes:
2323
label: Proposed Solution
24-
description: How would you solve this?
25-
placeholder: Describe your ideal solution
24+
description: How should this work? Be specific.
2625
validations:
2726
required: true
2827

2928
- type: textarea
3029
id: alternatives
3130
attributes:
3231
label: Alternatives Considered
33-
description: Any other approaches you've thought about?
34-
placeholder: Other ways to solve this
32+
description: What other solutions did you consider? Why is your proposal better?
3533

3634
- type: dropdown
3735
id: component
3836
attributes:
3937
label: Component
40-
description: Which part would this affect?
38+
description: Which part of the system would this affect?
4139
options:
42-
- MCP Tools
43-
- Search & Indexing
44-
- Dependency Analysis
45-
- Code Style Analysis
46-
- Frontend UI
47-
- Performance
48-
- Documentation
49-
- Other
40+
- Backend - API
41+
- Backend - Indexing
42+
- Backend - Search
43+
- Backend - Analysis (Dependencies/DNA/Style)
44+
- Frontend - Dashboard
45+
- Frontend - Search UI
46+
- MCP Server
47+
- New Component
48+
- Multiple Components
5049
validations:
5150
required: true
5251

53-
- type: checkboxes
54-
id: contribution
52+
- type: dropdown
53+
id: priority
54+
attributes:
55+
label: Priority
56+
description: How important is this feature?
57+
options:
58+
- Critical - Blocking major use case
59+
- High - Significant user value
60+
- Medium - Nice to have
61+
- Low - Minor improvement
62+
validations:
63+
required: true
64+
65+
- type: dropdown
66+
id: effort
5567
attributes:
56-
label: Contribution
57-
description: Would you be interested in implementing this?
68+
label: Estimated Effort
69+
description: How much work do you think this requires?
5870
options:
59-
- label: I'd like to work on this feature
71+
- Small (< 1 day)
72+
- Medium (1-3 days)
73+
- Large (1-2 weeks)
74+
- XL (> 2 weeks)
75+
- Unknown
76+
77+
- type: textarea
78+
id: mockups
79+
attributes:
80+
label: Mockups / Examples
81+
description: Any wireframes, mockups, or examples from other products?
82+
83+
- type: textarea
84+
id: acceptance
85+
attributes:
86+
label: Acceptance Criteria
87+
description: How do we know this feature is complete?
88+
placeholder: |
89+
- [ ] User can do X
90+
- [ ] System responds with Y
91+
- [ ] Performance meets Z threshold
Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
name: 🔧 Technical Debt / Refactor
2+
description: Code quality improvements, refactoring, or architectural changes
3+
title: "[Tech Debt]: "
4+
labels: ["tech-debt", "refactor"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Use this template for internal improvements that don't directly add features but improve code quality, maintainability, or performance.
10+
11+
- type: textarea
12+
id: current
13+
attributes:
14+
label: Current State
15+
description: What's the current implementation and why is it problematic?
16+
placeholder: |
17+
The current implementation does X which causes:
18+
- Problem 1
19+
- Problem 2
20+
validations:
21+
required: true
22+
23+
- type: textarea
24+
id: proposed
25+
attributes:
26+
label: Proposed Change
27+
description: What should we change and why is it better?
28+
validations:
29+
required: true
30+
31+
- type: textarea
32+
id: impact
33+
attributes:
34+
label: Impact Analysis
35+
description: What files/components are affected? What could break?
36+
placeholder: |
37+
Files affected:
38+
- file1.py
39+
- file2.py
40+
41+
Risk areas:
42+
- ...
43+
validations:
44+
required: true
45+
46+
- type: dropdown
47+
id: type
48+
attributes:
49+
label: Type of Change
50+
options:
51+
- Refactor - Same behavior, cleaner code
52+
- Performance - Speed or resource optimization
53+
- Architecture - Structural changes
54+
- Dependencies - Update/replace dependencies
55+
- Testing - Add/improve tests
56+
- Documentation - Code docs, comments, README
57+
validations:
58+
required: true
59+
60+
- type: dropdown
61+
id: priority
62+
attributes:
63+
label: Priority
64+
options:
65+
- Critical - Blocking development
66+
- High - Causing frequent issues
67+
- Medium - Improving maintainability
68+
- Low - Nice to have cleanup
69+
validations:
70+
required: true
71+
72+
- type: dropdown
73+
id: effort
74+
attributes:
75+
label: Estimated Effort
76+
options:
77+
- Small (< 1 day)
78+
- Medium (1-3 days)
79+
- Large (1-2 weeks)
80+
- XL (> 2 weeks)
81+
validations:
82+
required: true
83+
84+
- type: textarea
85+
id: migration
86+
attributes:
87+
label: Migration Plan
88+
description: If this is a breaking change, how do we migrate?
89+
placeholder: |
90+
1. Step 1
91+
2. Step 2
92+
3. Verification
93+
94+
- type: textarea
95+
id: tests
96+
attributes:
97+
label: Testing Strategy
98+
description: How do we verify this doesn't break anything?

0 commit comments

Comments
 (0)