Skip to content

Commit ffebcb2

Browse files
krokokokrokoko
authored
chore(doc): add templates for github issues (#97)
* chore(doc): add templates for github issues * chore(repo): address feedback from pr
1 parent 57c04fa commit ffebcb2

File tree

5 files changed

+253
-0
lines changed

5 files changed

+253
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 108 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,108 @@
1+
name: Bug Report
2+
description: Report a bug or unexpected behavior
3+
title: "[Bug]: "
4+
labels: ["bug"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to report a bug. Please fill out the sections below so we can reproduce and fix the issue.
10+
11+
- type: textarea
12+
id: description
13+
attributes:
14+
label: Description
15+
description: A clear and concise description of the bug.
16+
placeholder: Describe what went wrong.
17+
validations:
18+
required: true
19+
20+
- type: textarea
21+
id: steps
22+
attributes:
23+
label: Steps to Reproduce
24+
description: Steps to reproduce the behavior.
25+
placeholder: |
26+
1. Set up ...
27+
2. Run ...
28+
3. Observe ...
29+
validations:
30+
required: true
31+
32+
- type: textarea
33+
id: expected
34+
attributes:
35+
label: Expected Behavior
36+
description: What you expected to happen.
37+
validations:
38+
required: true
39+
40+
- type: textarea
41+
id: actual
42+
attributes:
43+
label: Actual Behavior
44+
description: What actually happened.
45+
validations:
46+
required: true
47+
48+
- type: input
49+
id: version
50+
attributes:
51+
label: AI-DLC Version
52+
description: Which version of AI-DLC are you using? Or the git commit hash if running from source.
53+
placeholder: e.g., 0.1.5 or abc1234
54+
validations:
55+
required: true
56+
57+
- type: dropdown
58+
id: phase
59+
attributes:
60+
label: AI-DLC Phase
61+
description: Which workflow phase were you in when the bug occurred?
62+
options:
63+
- Inception (requirements, user stories, application design)
64+
- Construction (component design, code generation, testing)
65+
- Operations (deployment, monitoring)
66+
- Not phase-specific
67+
validations:
68+
required: true
69+
70+
- type: dropdown
71+
id: platform
72+
attributes:
73+
label: Platform / IDE
74+
description: Which platform or IDE are you using AI-DLC with?
75+
multiple: true
76+
options:
77+
- Kiro IDE
78+
- Kiro CLI
79+
- Amazon Q Developer IDE Plugin
80+
- Cursor IDE
81+
- Cline
82+
- Claude Code
83+
- GitHub Copilot
84+
- Other
85+
validations:
86+
required: true
87+
88+
- type: input
89+
id: model
90+
attributes:
91+
label: AI Model
92+
description: Which AI model were you using?
93+
placeholder: e.g., Claude Sonnet 4, GPT-4o, Amazon Nova
94+
95+
- type: textarea
96+
id: environment
97+
attributes:
98+
label: Environment
99+
description: Any other relevant environment details (OS, IDE version, etc.).
100+
placeholder: |
101+
- OS: macOS 15.x
102+
- IDE: VS Code 1.x
103+
104+
- type: textarea
105+
id: additional
106+
attributes:
107+
label: Additional Context
108+
description: Add any other context, screenshots, or log output about the problem here.

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: true

‎.github/ISSUE_TEMPLATE/documentation.yml‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
name: Documentation Problem
2+
description: Report incorrect, unclear, or missing documentation
3+
title: "[Docs]: "
4+
labels: ["documentation"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Help us improve the documentation. Please describe the problem you found or what is missing.
10+
11+
- type: dropdown
12+
id: type
13+
attributes:
14+
label: Type of Documentation Problem
15+
options:
16+
- Incorrect or outdated information
17+
- Unclear or confusing explanation
18+
- Missing documentation
19+
- Broken link
20+
- Typo or formatting issue
21+
- Other
22+
validations:
23+
required: true
24+
25+
- type: textarea
26+
id: location
27+
attributes:
28+
label: Location
29+
description: Where is the problem? Provide a file path, URL, or section name.
30+
placeholder: e.g., README.md, "Platform-Specific Setup" section
31+
validations:
32+
required: true
33+
34+
- type: textarea
35+
id: description
36+
attributes:
37+
label: Description
38+
description: Describe what is wrong or missing.
39+
validations:
40+
required: true
41+
42+
- type: textarea
43+
id: suggestion
44+
attributes:
45+
label: Suggested Fix
46+
description: If you have a suggestion for how to fix the documentation, describe it here.

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
name: Feature Request
2+
description: Suggest a small enhancement or improvement
3+
title: "[Feature]: "
4+
labels: ["enhancement"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Suggest an enhancement or improvement. For larger, design-level proposals, please use the [RFC template](https://github.com/awslabs/aidlc-workflows/issues/new?template=rfc.yml) instead.
10+
11+
- type: textarea
12+
id: description
13+
attributes:
14+
label: Description
15+
description: A clear and concise description of the feature or improvement you'd like.
16+
validations:
17+
required: true
18+
19+
- type: textarea
20+
id: use-case
21+
attributes:
22+
label: Use Case
23+
description: What problem does this solve or what workflow does it improve?
24+
validations:
25+
required: true
26+
27+
- type: dropdown
28+
id: area
29+
attributes:
30+
label: Area
31+
description: What area of AI-DLC does this relate to?
32+
options:
33+
- Inception phase rules
34+
- Construction phase rules
35+
- Operations phase rules
36+
- New extension (e.g., compliance, security)
37+
- Platform support
38+
- Documentation
39+
- Other
40+
validations:
41+
required: true
42+
43+
- type: textarea
44+
id: additional
45+
attributes:
46+
label: Additional Context
47+
description: Any other context, examples, or references that help explain the request.

‎.github/ISSUE_TEMPLATE/rfc.yml‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
name: RFC (Request for Comments)
2+
description: Propose a significant change or new feature for discussion
3+
title: "[RFC]: "
4+
labels: ["rfc"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Use this template to propose a significant change or new feature. RFCs are meant to gather feedback before implementation begins.
10+
11+
- type: textarea
12+
id: summary
13+
attributes:
14+
label: Summary
15+
description: A brief one-paragraph summary of the proposal.
16+
validations:
17+
required: true
18+
19+
- type: textarea
20+
id: motivation
21+
attributes:
22+
label: Motivation
23+
description: Why should this change be made? What problem does it solve or what use case does it enable?
24+
validations:
25+
required: true
26+
27+
- type: textarea
28+
id: proposal
29+
attributes:
30+
label: Detailed Proposal
31+
description: Describe the proposed change in detail. Include specifics on how it would work.
32+
validations:
33+
required: true
34+
35+
- type: textarea
36+
id: alternatives
37+
attributes:
38+
label: Alternatives Considered
39+
description: What other approaches did you consider and why were they not chosen?
40+
41+
- type: textarea
42+
id: drawbacks
43+
attributes:
44+
label: Drawbacks
45+
description: Are there any reasons why this proposal should not be adopted?
46+
47+
- type: textarea
48+
id: additional
49+
attributes:
50+
label: Additional Context
51+
description: Any other information, mockups, references, or examples that help explain the proposal.

0 commit comments

Comments
 (0)