Skip to content

Commit af769ec

Browse files
56kyle56kyle
committed
feat: add initial generation of some templates
1 parent 232cd5c commit af769ec

6 files changed

Lines changed: 493 additions & 5 deletions

File tree

‎.github/ISSUE_TEMPLATE/01_template_bug.yml‎

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
name: '🔧 Template Bug Report'
2+
description: Report a bug with the cookiecutter template itself (generation process, hooks, scripts)
3+
labels: [bug, template]
4+
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
**This template is for issues with the cookiecutter template itself** - problems during generation, template scripts, or template configuration.
10+
11+
For issues with the **generated project** (nox sessions, dependencies, tooling), please use the "Generated Project Bug Report" template instead.
12+
13+
- type: textarea
14+
id: description
15+
attributes:
16+
label: Bug description
17+
description: A clear description of the template issue
18+
placeholder: ex. Template generation fails when selecting Rust extension...
19+
validations:
20+
required: true
21+
22+
- type: dropdown
23+
id: issue_stage
24+
attributes:
25+
label: When does the issue occur?
26+
options:
27+
- During cookiecutter prompts/input
28+
- During template file generation
29+
- During post-generation hooks
30+
- When running template nox commands (generate-demo, lint, test, etc.)
31+
- Template documentation/structure issues
32+
validations:
33+
required: true
34+
35+
- type: textarea
36+
id: reproduction
37+
attributes:
38+
label: Steps to reproduce
39+
placeholder: |
40+
1. Run `cookiecutter gh:56kyle/cookiecutter-robust-python`
41+
2. Select options: {...}
42+
3. See error during generation
43+
validations:
44+
required: true
45+
46+
- type: textarea
47+
id: cookiecutter_config
48+
attributes:
49+
label: Cookiecutter configuration
50+
description: The options you selected (from .cookiecutter.json if generation succeeded)
51+
render: json
52+
validations:
53+
required: false
54+
55+
- type: textarea
56+
id: environment
57+
attributes:
58+
label: Environment
59+
value: |
60+
- OS:
61+
- Python version:
62+
- Cookiecutter version:
63+
- Template commit/version:
64+
validations:
65+
required: true
66+
67+
- type: textarea
68+
id: error_output
69+
attributes:
70+
label: Error output
71+
description: Full error messages, stack traces, or command output
72+
render: shell
73+
validations:
74+
required: false

‎.github/ISSUE_TEMPLATE/02_generated_project_bug.yml‎

Lines changed: 102 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
name: '📦 Generated Project Bug Report'
2+
description: Report a bug with the generated project (nox sessions, dependencies, tooling, structure)
3+
labels: [bug, generated-project]
4+
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
**This template is for issues with generated projects** - problems with nox sessions, dependencies, tooling configuration, or project structure.
10+
11+
For issues with the **cookiecutter template itself** (generation process, template scripts), please use the "Template Bug Report" template instead.
12+
13+
- type: textarea
14+
id: description
15+
attributes:
16+
label: Bug description
17+
description: A clear description of the issue in the generated project
18+
placeholder: ex. nox -s tests-python fails with import errors...
19+
validations:
20+
required: true
21+
22+
- type: dropdown
23+
id: issue_category
24+
attributes:
25+
label: Issue category
26+
options:
27+
- Nox session failures
28+
- Dependency/package management issues
29+
- Build/packaging problems
30+
- Testing framework issues
31+
- Documentation build issues
32+
- Linting/formatting configuration
33+
- Type checking issues
34+
- Security scanning problems
35+
- CI/CD workflow issues
36+
- Rust extension issues (if applicable)
37+
- Container/Docker issues
38+
- Project structure/template files
39+
- Other
40+
validations:
41+
required: true
42+
43+
- type: textarea
44+
id: reproduction
45+
attributes:
46+
label: Steps to reproduce
47+
placeholder: |
48+
1. Generate project with: cookiecutter gh:56kyle/cookiecutter-robust-python
49+
2. Select options: {...}
50+
3. Run: nox -s tests-python
51+
4. See error: {...}
52+
validations:
53+
required: true
54+
55+
- type: textarea
56+
id: cookiecutter_config
57+
attributes:
58+
label: Project configuration
59+
description: Contents of .cookiecutter.json from your generated project
60+
render: json
61+
validations:
62+
required: true
63+
64+
- type: dropdown
65+
id: rust_extension
66+
attributes:
67+
label: Does your project use Rust extension?
68+
options:
69+
- "No"
70+
- "Yes"
71+
validations:
72+
required: true
73+
74+
- type: textarea
75+
id: environment
76+
attributes:
77+
label: Environment
78+
value: |
79+
- OS:
80+
- Python version:
81+
- uv version:
82+
- nox version:
83+
- Template version used:
84+
validations:
85+
required: true
86+
87+
- type: textarea
88+
id: command_output
89+
attributes:
90+
label: Command output
91+
description: Full output of the failing command(s)
92+
render: shell
93+
validations:
94+
required: false
95+
96+
- type: textarea
97+
id: workaround
98+
attributes:
99+
label: Workaround (if any)
100+
description: If you found a way to work around the issue, please describe it
101+
validations:
102+
required: false

‎.github/ISSUE_TEMPLATE/03_documentation.yml‎

Lines changed: 51 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,69 @@
11
name: '📖 Documentation improvement'
2-
description: Report an issue with the documentation.
2+
description: Report an issue with the documentation or suggest improvements
33
labels: [documentation]
44

55
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Use this template for issues with:
10+
- Template documentation (README, docs/ folder)
11+
- Generated project documentation
12+
- Missing or unclear documentation
13+
- Documentation build issues
14+
15+
- type: dropdown
16+
id: doc_type
17+
attributes:
18+
label: Documentation type
19+
options:
20+
- Template documentation (this repository)
21+
- Generated project documentation template
22+
- API/code documentation
23+
- Usage guides/tutorials
24+
- Configuration documentation
25+
- Troubleshooting guides
26+
- Other
27+
validations:
28+
required: true
29+
630
- type: textarea
731
id: description
832
attributes:
933
label: Description
10-
description: >
11-
Describe the issue with the documentation and how it can be fixed or improved.
34+
description: Describe the documentation issue and how it can be improved
35+
placeholder: ex. The nox session documentation is missing examples for Rust projects...
1236
validations:
1337
required: true
1438

1539
- type: input
1640
id: link
1741
attributes:
1842
label: Link
19-
description: >
20-
Provide a link to the existing documentation, if applicable.
43+
description: Link to the existing documentation (if applicable)
2144
placeholder: ex. https://cookiecutter-robust-python.readthedocs.io/en/latest/...
2245
validations:
2346
required: false
47+
48+
- type: dropdown
49+
id: issue_type
50+
attributes:
51+
label: Issue type
52+
options:
53+
- Missing documentation
54+
- Incorrect/outdated information
55+
- Unclear explanation
56+
- Documentation build failure
57+
- Broken links
58+
- Formatting issues
59+
- Suggestion for improvement
60+
validations:
61+
required: true
62+
63+
- type: textarea
64+
id: suggested_improvement
65+
attributes:
66+
label: Suggested improvement
67+
description: How should this documentation be improved?
68+
validations:
69+
required: false

‎.github/ISSUE_TEMPLATE/04_template_feature.yml‎

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
name: '✨ Template Feature Request'
2+
description: Suggest a new feature or improvement for the cookiecutter template itself
3+
labels: [enhancement, template]
4+
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
**This template is for feature requests for the cookiecutter template itself** - new cookiecutter options, template structure changes, or template functionality.
10+
11+
For improvements to **generated projects** (new nox sessions, tooling updates, project features), please use the "Generated Project Feature Request" template instead.
12+
13+
- type: textarea
14+
id: problem
15+
attributes:
16+
label: Problem or use case
17+
description: What problem would this feature solve? What use case would it enable?
18+
placeholder: ex. I want to be able to choose between different CI providers during template generation...
19+
validations:
20+
required: true
21+
22+
- type: textarea
23+
id: solution
24+
attributes:
25+
label: Proposed solution
26+
description: Describe your proposed solution or feature
27+
placeholder: ex. Add a new cookiecutter variable 'ci_provider' with options for GitHub Actions, GitLab CI, etc...
28+
validations:
29+
required: true
30+
31+
- type: dropdown
32+
id: feature_type
33+
attributes:
34+
label: Feature type
35+
options:
36+
- New cookiecutter variable/option
37+
- New template files or structure
38+
- New post-generation hooks
39+
- New template nox sessions
40+
- Template documentation improvements
41+
- Template testing improvements
42+
- Other template functionality
43+
validations:
44+
required: true
45+
46+
- type: textarea
47+
id: implementation
48+
attributes:
49+
label: Implementation ideas
50+
description: Any ideas on how this could be implemented? (optional)
51+
validations:
52+
required: false
53+
54+
- type: textarea
55+
id: alternatives
56+
attributes:
57+
label: Alternatives considered
58+
description: What alternatives have you considered?
59+
validations:
60+
required: false
61+
62+
- type: dropdown
63+
id: breaking_change
64+
attributes:
65+
label: Would this be a breaking change?
66+
description: Would this change break existing template usage or generated projects?
67+
options:
68+
- "No - backward compatible"
69+
- "Yes - breaking change"
70+
- "Unsure"
71+
validations:
72+
required: true
73+
74+
- type: textarea
75+
id: additional_context
76+
attributes:
77+
label: Additional context
78+
description: Add any other context, screenshots, or examples
79+
validations:
80+
required: false

0 commit comments

Comments
 (0)