Skip to content

Commit 9028607

Browse files
authored
Merge pull request #40 from 56kyle/feature/add-github-templates-to-cookiecutter
Add Issue Templates for cookiecutter
2 parents f6b0e9d + 89fd85d commit 9028607

File tree

4 files changed

+170
-0
lines changed

4 files changed

+170
-0
lines changed
Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
name: '🐛 Bug Report'
2+
description: Report a bug with the template or generated projects
3+
labels: [bug]
4+
title: '[Bug] '
5+
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Thanks for taking the time to report a bug! Please provide as much detail as possible.
11+
12+
- type: dropdown
13+
id: issue_scope
14+
attributes:
15+
label: Is this a template issue or generated project issue?
16+
options:
17+
- Template/Cookiecutter
18+
- Generated Project
19+
validations:
20+
required: true
21+
22+
- type: textarea
23+
id: description
24+
attributes:
25+
label: Bug Description
26+
description: A clear and concise description of the bug
27+
placeholder: |
28+
What went wrong? Please be as specific as possible.
29+
validations:
30+
required: true
31+
32+
- type: textarea
33+
id: reproduction
34+
attributes:
35+
label: Steps to Reproduce
36+
description: How can we reproduce this issue?
37+
placeholder: |
38+
Either a minimum reproducible example or detailed steps.
39+
validations:
40+
required: true
41+
42+
- type: textarea
43+
id: environment
44+
attributes:
45+
label: Environment
46+
description: Please provide relevant environment details
47+
value: |
48+
- OS:
49+
- Python version:
50+
- Cookiecutter version (if template issue):
51+
- Project configuration (rust extension enabled?):
52+
validations:
53+
required: true
54+
55+
- type: textarea
56+
id: additional
57+
attributes:
58+
label: Additional Context
59+
description: Any other information that might be helpful
60+
validations:
61+
required: false
Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
name: '✨ Feature Request'
2+
description: Suggest new features or improvements
3+
labels: [enhancement]
4+
title: '[Feature] '
5+
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Thanks for suggesting a feature! Please help us understand your idea.
11+
12+
- type: dropdown
13+
id: feature_scope
14+
attributes:
15+
label: Is this for the template or generated projects?
16+
options:
17+
- Template (new options, generation features)
18+
- Generated Project (tooling, structure)
19+
- Both
20+
validations:
21+
required: true
22+
23+
- type: textarea
24+
id: summary
25+
attributes:
26+
label: Feature Summary
27+
description: What feature would you like to see?
28+
placeholder: |
29+
A brief description of the feature you're requesting...
30+
validations:
31+
required: true
32+
33+
- type: textarea
34+
id: example
35+
attributes:
36+
label: Example
37+
description: How would this look to the end user?
38+
placeholder: |
39+
Show an example of how this would work or what the user would see/do...
40+
validations:
41+
required: true
42+
43+
- type: textarea
44+
id: additional
45+
attributes:
46+
label: Additional Context
47+
description: Any other relevant information about this feature request
48+
validations:
49+
required: false
Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
name: '📖 Documentation Issue'
2+
description: Report documentation issues or suggest improvements
3+
labels: [documentation]
4+
title: '[Docs] '
5+
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Help us improve our documentation!
11+
12+
- type: dropdown
13+
id: doc_type
14+
attributes:
15+
label: What type of documentation issue is this?
16+
options:
17+
- Missing documentation
18+
- Incorrect/outdated information
19+
- Unclear explanation
20+
- Broken links
21+
- Other improvement
22+
validations:
23+
required: true
24+
25+
- type: textarea
26+
id: description
27+
attributes:
28+
label: Description
29+
description: Describe the documentation issue
30+
placeholder: |
31+
What's wrong with the documentation? What needs to be improved?
32+
validations:
33+
required: true
34+
35+
- type: input
36+
id: link
37+
attributes:
38+
label: Documentation Link
39+
description: Link to the problematic documentation (if applicable)
40+
placeholder: https://...
41+
validations:
42+
required: false
43+
44+
- type: textarea
45+
id: suggestion
46+
attributes:
47+
label: Suggested Improvement
48+
description: How would you improve this documentation?
49+
placeholder: |
50+
What changes would make this clearer or more helpful?
51+
validations:
52+
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: ❓ Questions & Support
4+
url: https://github.com/56kyle/cookiecutter-robust-python/discussions
5+
about: Ask questions and get help using cookiecutter-robust-python
6+
- name: 💬 General Discussion
7+
url: https://github.com/56kyle/cookiecutter-robust-python/discussions
8+
about: Discuss ideas, best practices, and share your projects

0 commit comments

Comments
 (0)