Skip to content

Commit e0ad286

Browse files
kdinevKonstantin DinevCopilot
authored
feat(*): new issue/pr templates (#1632)
* feat(*): new issue/pr templates * chore(*): updating work item types * Update .github/PULL_REQUEST_TEMPLATE.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --------- Co-authored-by: Konstantin Dinev <kdinev@mail.bw.edu> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
1 parent 4589581 commit e0ad286

4 files changed

Lines changed: 275 additions & 24 deletions

File tree

‎.github/ISSUE_TEMPLATE.md‎

Lines changed: 0 additions & 22 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 148 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,148 @@
1+
---
2+
name: Bug Report
3+
description: Report a bug with the Ignite UI CLI
4+
labels: ["bug"]
5+
type: Bug
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Thank you for reporting a bug! Please fill out the sections below so we can reproduce and fix the issue.
11+
12+
- type: input
13+
id: cli-version
14+
attributes:
15+
label: Ignite UI CLI Version
16+
description: "Run `ig --version` to find your CLI version."
17+
placeholder: "e.g. 13.2.0"
18+
validations:
19+
required: true
20+
21+
- type: dropdown
22+
id: framework
23+
attributes:
24+
label: Framework
25+
description: Which framework are you using?
26+
options:
27+
- Angular
28+
- React
29+
- jQuery
30+
- Web Components
31+
validations:
32+
required: true
33+
34+
- type: dropdown
35+
id: project-type
36+
attributes:
37+
label: Project Type
38+
description: Which project type are you using?
39+
options:
40+
- igx-ts (Angular)
41+
- igr-ts (React)
42+
- js (jQuery)
43+
- igc-ts (Web Components)
44+
validations:
45+
required: true
46+
47+
- type: dropdown
48+
id: command
49+
attributes:
50+
label: CLI Command
51+
description: Which command is not working as expected?
52+
options:
53+
- new
54+
- add
55+
- generate
56+
- start
57+
- build
58+
- test
59+
- config
60+
- list
61+
- doc
62+
- upgrade-packages
63+
- Other
64+
validations:
65+
required: true
66+
67+
- type: input
68+
id: node-version
69+
attributes:
70+
label: Node.js Version
71+
description: "Run `node --version` to find your Node.js version."
72+
placeholder: "e.g. 20.11.0"
73+
validations:
74+
required: true
75+
76+
- type: dropdown
77+
id: os
78+
attributes:
79+
label: Operating System
80+
options:
81+
- Windows
82+
- macOS
83+
- Linux
84+
validations:
85+
required: true
86+
87+
- type: dropdown
88+
id: package-manager
89+
attributes:
90+
label: Package Manager
91+
options:
92+
- npm
93+
- yarn
94+
validations:
95+
required: false
96+
97+
- type: textarea
98+
id: description
99+
attributes:
100+
label: Description
101+
description: A clear and concise description of the bug.
102+
validations:
103+
required: true
104+
105+
- type: textarea
106+
id: steps
107+
attributes:
108+
label: Steps to Reproduce
109+
description: List the steps to reproduce the issue.
110+
value: |
111+
1.
112+
2.
113+
3.
114+
validations:
115+
required: true
116+
117+
- type: textarea
118+
id: actual
119+
attributes:
120+
label: Actual Result
121+
description: What happened after following the steps above?
122+
validations:
123+
required: true
124+
125+
- type: textarea
126+
id: expected
127+
attributes:
128+
label: Expected Result
129+
description: What did you expect to happen?
130+
validations:
131+
required: true
132+
133+
- type: textarea
134+
id: error-output
135+
attributes:
136+
label: Error Output / Logs
137+
description: Paste any relevant error messages or terminal output.
138+
render: shell
139+
validations:
140+
required: false
141+
142+
- type: textarea
143+
id: attachments
144+
attributes:
145+
label: Additional Context
146+
description: Add screenshots, sample projects, or any other context.
147+
validations:
148+
required: false

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
---
2+
name: Feature Request
3+
description: Suggest a new feature or improvement for the Ignite UI CLI
4+
labels: ["feature-request"]
5+
type: Feature
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Thank you for suggesting a feature! Please describe your idea so we can evaluate and prioritize it.
11+
12+
- type: dropdown
13+
id: framework
14+
attributes:
15+
label: Framework
16+
description: Which framework does this feature apply to?
17+
multiple: true
18+
options:
19+
- Angular
20+
- React
21+
- jQuery
22+
- Web Components
23+
- All / Not framework-specific
24+
validations:
25+
required: true
26+
27+
- type: dropdown
28+
id: command
29+
attributes:
30+
label: Related CLI Command
31+
description: Which CLI command is this feature related to, if any?
32+
options:
33+
- new
34+
- add
35+
- generate
36+
- start
37+
- build
38+
- test
39+
- config
40+
- list
41+
- doc
42+
- upgrade-packages
43+
- Not command-specific
44+
validations:
45+
required: false
46+
47+
- type: dropdown
48+
id: area
49+
attributes:
50+
label: Feature Area
51+
description: What area does this feature fall under?
52+
options:
53+
- New template / component
54+
- CLI command improvement
55+
- Project scaffolding
56+
- Developer experience
57+
- Documentation
58+
- Performance
59+
- Other
60+
validations:
61+
required: true
62+
63+
- type: textarea
64+
id: problem
65+
attributes:
66+
label: Problem Statement
67+
description: Describe the problem or limitation you are experiencing. What workflow is difficult or impossible today?
68+
validations:
69+
required: true
70+
71+
- type: textarea
72+
id: solution
73+
attributes:
74+
label: Proposed Solution
75+
description: Describe the solution or feature you'd like to see.
76+
validations:
77+
required: true
78+
79+
- type: textarea
80+
id: alternatives
81+
attributes:
82+
label: Alternatives Considered
83+
description: Have you considered any alternative solutions or workarounds?
84+
validations:
85+
required: false
86+
87+
- type: textarea
88+
id: context
89+
attributes:
90+
label: Additional Context
91+
description: Add any other context, mockups, or references.
92+
validations:
93+
required: false

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 34 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,36 @@
1-
Closes # .
1+
## Description
22

3-
Additional information related to this pull request:
3+
<!-- Provide a clear summary of the changes and the motivation behind them. -->
44

5+
## Related Issue
6+
7+
Closes #<issue-number>
8+
9+
## Type of Change
10+
11+
- [ ] Bug fix (non-breaking change that fixes an issue)
12+
- [ ] New feature (non-breaking change that adds functionality)
13+
- [ ] Breaking change (fix or feature that would cause existing functionality to change)
14+
- [ ] Documentation update
15+
- [ ] Refactoring / code cleanup
16+
- [ ] Build / CI configuration change
17+
18+
## Affected Packages
19+
20+
- [ ] `igniteui-cli` (packages/cli)
21+
- [ ] `@igniteui/cli-core` (packages/core)
22+
- [ ] `@igniteui/angular-templates` (packages/igx-templates)
23+
- [ ] `@igniteui/angular-schematics` (packages/ng-schematics)
24+
- [ ] `@igniteui/mcp-server` (packages/igniteui-mcp)
25+
26+
## Checklist
27+
28+
- [ ] I have tested my changes locally (`npm run test`)
29+
- [ ] I have built the project successfully (`npm run build`)
30+
- [ ] I have run the linter (`npm run lint`)
31+
- [ ] I have added/updated tests as needed
32+
- [ ] My changes do not introduce new warnings or errors
33+
34+
## Additional Context
35+
36+
<!-- Add any screenshots, sample output, or other context about the pull request. -->

0 commit comments

Comments
 (0)