Skip to content

Commit 6b8b3ef

Browse files
Merge pull request #5 from ecarrenolozano/master
[FEAT] Add issue templates for common report/requests.
2 parents 9994d74 + e0b1b7a commit 6b8b3ef

File tree

5 files changed

+178
-0
lines changed

5 files changed

+178
-0
lines changed
Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
name: Bug Report
2+
description: Report a problem with the cookiecutter template or the generated project.
3+
title: '[BUG] '
4+
labels: [bug]
5+
body:
6+
- type: textarea
7+
id: description
8+
attributes:
9+
label: Description
10+
description: Describe the bug clearly and concisely.
11+
placeholder: What happened?
12+
validations:
13+
required: true
14+
15+
- type: textarea
16+
id: reproduce
17+
attributes:
18+
label: Steps to Reproduce
19+
description: Provide all steps, including Cookiecutter prompts.
20+
placeholder: |
21+
1.
22+
2.
23+
3.
24+
validations:
25+
required: true
26+
27+
- type: textarea
28+
id: expected
29+
attributes:
30+
label: Expected Behavior
31+
description: Describe what you expected to happen.
32+
validations:
33+
required: true
34+
35+
- type: textarea
36+
id: actual
37+
attributes:
38+
label: Actual Behavior / Logs
39+
description: Include error messages, stack traces, or relevant output.
40+
render: shell
41+
42+
- type: input
43+
id: environment
44+
attributes:
45+
label: Environment
46+
description: Python version, OS, Cookiecutter version.
47+
placeholder: Python 3.12.1, Ubuntu 22.04, Cookiecutter 2.3
Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
name: Feature Request
2+
description: Suggest an improvement for the Cookiecutter template.
3+
title: "[Feature] "
4+
labels: [enhancement]
5+
body:
6+
- type: textarea
7+
id: summary
8+
attributes:
9+
label: Summary
10+
description: Describe the feature you propose.
11+
placeholder: What should be added or improved?
12+
validations:
13+
required: true
14+
15+
- type: textarea
16+
id: benefits
17+
attributes:
18+
label: Rationale
19+
description: Why is this feature valuable? How will users benefit?
20+
validations:
21+
required: true
22+
23+
- type: textarea
24+
id: design
25+
attributes:
26+
label: Proposed Design
27+
description: Describe how the feature could be implemented. Include template variables, folder layout changes, etc.
28+
29+
- type: textarea
30+
id: compatibility
31+
attributes:
32+
label: Backward Compatibility
33+
description: Could this change break existing generated projects?
34+
35+
- type: textarea
36+
id: alternatives
37+
attributes:
38+
label: Alternatives
39+
description: Are there other solutions or approaches?
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
name: Cookiecutter Option Request
2+
description: Propose a new Cookiecutter variable or configuration option.
3+
title: "[Option] "
4+
labels: [enhancement, cookiecutter]
5+
body:
6+
- type: input
7+
id: option_name
8+
attributes:
9+
label: Option Name
10+
placeholder: e.g., enable_fastapi
11+
validations:
12+
required: true
13+
14+
- type: textarea
15+
id: purpose
16+
attributes:
17+
label: Purpose
18+
description: Why should this option exist?
19+
20+
- type: textarea
21+
id: default
22+
attributes:
23+
label: Default Value
24+
placeholder: "true / false / string"
25+
26+
- type: textarea
27+
id: impact
28+
attributes:
29+
label: Impact on Template
30+
description: What directories, files, or hooks would be affected?
31+
32+
- type: textarea
33+
id: implementation
34+
attributes:
35+
label: Suggested Implementation
36+
description: Optional but helpful.
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
name: Documentation Improvement
2+
description: Suggest updates to the README or the generated project docs.
3+
title: "[Docs] "
4+
labels: [documentation]
5+
body:
6+
- type: textarea
7+
id: scope
8+
attributes:
9+
label: Topic
10+
description: What documentation needs improvement?
11+
12+
- type: textarea
13+
id: problem
14+
attributes:
15+
label: Problem
16+
description: What is unclear, inaccurate, or missing?
17+
18+
- type: textarea
19+
id: solution
20+
attributes:
21+
label: Proposed Improvement
22+
description: How should the documentation be improved?
23+
24+
- type: textarea
25+
id: references
26+
attributes:
27+
label: References
28+
description: Add links or examples if applicable.
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
name: Template UX Feedback
2+
description: Provide feedback on usability and user experience of the template.
3+
title: "[UX] "
4+
labels: [feedback]
5+
body:
6+
- type: textarea
7+
id: experience
8+
attributes:
9+
label: User Experience
10+
description: Describe your experience generating a project.
11+
12+
- type: textarea
13+
id: prompts
14+
attributes:
15+
label: Cookiecutter Prompts
16+
description: Were the prompts intuitive and clear?
17+
18+
- type: textarea
19+
id: pain_points
20+
attributes:
21+
label: Pain Points
22+
description: What felt confusing, unnecessary, or complicated?
23+
24+
- type: textarea
25+
id: suggestions
26+
attributes:
27+
label: Suggestions
28+
description: How can we improve the template experience?

0 commit comments

Comments
 (0)