cicd: adding more detail to the template issue templates

Author: 56kyle

.github/ISSUE_TEMPLATE/01_template_bug.yml

@@ -1,61 +1,81 @@
 name: '🔧 Template Bug Report'
 description: Report a bug with the cookiecutter template itself (generation process, hooks, scripts)
 labels: [bug, template]
+title: '[Template Bug] '
 
 body:
   - type: markdown
     attributes:
       value: |
-        **This template is for issues with the cookiecutter template itself** - problems during generation, template scripts, or template configuration.
+        ## Template Bug Report
         
-        For issues with the **generated project** (nox sessions, dependencies, tooling), please use the "Generated Project Bug Report" template instead.
+        Report issues with the **cookiecutter template itself** including:
+        - Template generation failures
+        - Post-generation hook errors  
+        - Template script problems
+        - Template configuration issues
+        
+        > **Note:** For issues with **generated projects** (nox sessions, dependencies, tooling), use the "Generated Project Bug Report" template instead.
 
   - type: textarea
     id: description
     attributes:
-      label: Bug description
-      description: A clear description of the template issue
-      placeholder: ex. Template generation fails when selecting Rust extension...
+      label: 📝 Bug Description
+      description: Clearly describe what went wrong with the template
+      placeholder: |
+        Example: Template generation fails when selecting Rust extension with error "...
     validations:
       required: true
 
   - type: dropdown
     id: issue_stage
     attributes:
-      label: When does the issue occur?
+      label: 🎯 When does the issue occur?
       options:
         - During cookiecutter prompts/input
         - During template file generation
         - During post-generation hooks
-        - When running template nox commands (generate-demo, lint, test, etc.)
+        - Template nox commands (generate-demo, lint, test, etc.)
         - Template documentation/structure issues
     validations:
       required: true
 
   - type: textarea
     id: reproduction
     attributes:
-      label: Steps to reproduce
+      label: 🔄 Steps to Reproduce
+      description: Provide clear steps to reproduce the issue
       placeholder: |
-        1. Run `cookiecutter gh:56kyle/cookiecutter-robust-python`
-        2. Select options: {...}
-        3. See error during generation
+        1. Run: cookiecutter gh:56kyle/cookiecutter-robust-python
+        2. Select options: {project_name: "test", add_rust_extension: "yes"}
+        3. Error occurs: ...
+      value: |
+        1. 
+        2. 
+        3. 
     validations:
       required: true
 
   - type: textarea
     id: cookiecutter_config
     attributes:
-      label: Cookiecutter configuration
-      description: The options you selected (from .cookiecutter.json if generation succeeded)
+      label: ⚙️ Cookiecutter Configuration
+      description: Paste your .cookiecutter.json file contents or the options you selected
       render: json
+      placeholder: |
+        {
+          "project_name": "my-project",
+          "add_rust_extension": "yes",
+          ...
+        }
     validations:
       required: false
 
   - type: textarea
     id: environment
     attributes:
-      label: Environment
+      label: 🖥️ Environment
+      description: Please fill in your system information
       value: |
         - OS: 
         - Python version: 
@@ -67,8 +87,10 @@ body:
   - type: textarea
     id: error_output
     attributes:
-      label: Error output
-      description: Full error messages, stack traces, or command output
+      label: 🚨 Error Output
+      description: Paste the complete error message, stack trace, or command output
       render: shell
+      placeholder: |
+        Paste full error output here...
     validations:
       required: false

.github/ISSUE_TEMPLATE/02_generated_project_bug.yml

@@ -1,70 +1,92 @@
 name: '📦 Generated Project Bug Report'
 description: Report a bug with the generated project (nox sessions, dependencies, tooling, structure)
 labels: [bug, generated-project]
+title: '[Generated Project Bug] '
 
 body:
   - type: markdown
     attributes:
       value: |
-        **This template is for issues with generated projects** - problems with nox sessions, dependencies, tooling configuration, or project structure.
+        ## Generated Project Bug Report
         
-        For issues with the **cookiecutter template itself** (generation process, template scripts), please use the "Template Bug Report" template instead.
+        Report issues with **generated projects** including:
+        - Nox session failures
+        - Dependency or tooling problems
+        - Build/packaging issues
+        - Testing framework errors
+        - Project configuration problems
+        
+        > **Note:** For issues with the **cookiecutter template itself** (generation process, template scripts), use the "Template Bug Report" template instead.
 
   - type: textarea
     id: description
     attributes:
-      label: Bug description
-      description: A clear description of the issue in the generated project
-      placeholder: ex. nox -s tests-python fails with import errors...
+      label: 📝 Bug Description
+      description: Clearly describe the issue in your generated project
+      placeholder: |
+        Example: Running 'nox -s tests-python' fails with import errors...
     validations:
       required: true
 
   - type: dropdown
     id: issue_category
     attributes:
-      label: Issue category
+      label: 🏷️ Issue Category
       options:
         - Nox session failures
-        - Dependency/package management issues
+        - Dependency/package management
         - Build/packaging problems
         - Testing framework issues
         - Documentation build issues
         - Linting/formatting configuration
         - Type checking issues
         - Security scanning problems
         - CI/CD workflow issues
-        - Rust extension issues (if applicable)
+        - Rust extension issues
         - Container/Docker issues
-        - Project structure/template files
+        - Project structure/files
         - Other
     validations:
       required: true
 
   - type: textarea
     id: reproduction
     attributes:
-      label: Steps to reproduce
+      label: 🔄 Steps to Reproduce
+      description: Provide clear steps to reproduce the issue
       placeholder: |
-        1. Generate project with: cookiecutter gh:56kyle/cookiecutter-robust-python
-        2. Select options: {...}
-        3. Run: nox -s tests-python
-        4. See error: {...}
+        1. Generate project: cookiecutter gh:56kyle/cookiecutter-robust-python
+        2. Select options: {project_name: "test", add_rust_extension: "no"}
+        3. Run command: nox -s tests-python
+        4. Error occurs: ...
+      value: |
+        1. 
+        2. 
+        3. 
+        4. 
     validations:
       required: true
 
   - type: textarea
     id: cookiecutter_config
     attributes:
-      label: Project configuration
-      description: Contents of .cookiecutter.json from your generated project
+      label: ⚙️ Project Configuration
+      description: Paste the contents of .cookiecutter.json from your generated project
       render: json
+      placeholder: |
+        {
+          "project_name": "my-project",
+          "add_rust_extension": "no",
+          ...
+        }
     validations:
       required: true
 
   - type: dropdown
     id: rust_extension
     attributes:
-      label: Does your project use Rust extension?
+      label: 🦀 Rust Extension
+      description: Does your project include Rust extensions?
       options:
         - "No"
         - "Yes"
@@ -74,7 +96,8 @@ body:
   - type: textarea
     id: environment
     attributes:
-      label: Environment
+      label: 🖥️ Environment
+      description: Please fill in your system information
       value: |
         - OS: 
         - Python version: 
@@ -87,16 +110,20 @@ body:
   - type: textarea
     id: command_output
     attributes:
-      label: Command output
-      description: Full output of the failing command(s)
+      label: 💻 Command Output
+      description: Paste the complete output of the failing command(s)
       render: shell
+      placeholder: |
+        Paste full command output here...
     validations:
       required: false
 
   - type: textarea
     id: workaround
     attributes:
-      label: Workaround (if any)
-      description: If you found a way to work around the issue, please describe it
+      label: 🔧 Workaround
+      description: If you found a temporary solution, please describe it
+      placeholder: |
+        Example: Manually editing pyproject.toml to fix the dependency version...
     validations:
       required: false

.github/ISSUE_TEMPLATE/03_documentation.yml

@@ -1,21 +1,25 @@
-name: '📖 Documentation improvement'
-description: Report an issue with the documentation or suggest improvements
+name: '📖 Documentation Issue'
+description: Report documentation issues or suggest improvements
 labels: [documentation]
+title: '[Docs] '
 
 body:
   - type: markdown
     attributes:
       value: |
-        Use this template for issues with:
+        ## Documentation Issue
+        
+        Report problems or suggest improvements for:
         - Template documentation (README, docs/ folder)
-        - Generated project documentation
+        - Generated project documentation templates
         - Missing or unclear documentation
         - Documentation build issues
+        - API/code documentation
 
   - type: dropdown
     id: doc_type
     attributes:
-      label: Documentation type
+      label: 📁 Documentation Type
       options:
         - Template documentation (this repository)
         - Generated project documentation template
@@ -30,25 +34,26 @@ body:
   - type: textarea
     id: description
     attributes:
-      label: Description
-      description: Describe the documentation issue and how it can be improved
-      placeholder: ex. The nox session documentation is missing examples for Rust projects...
+      label: 📝 Issue Description
+      description: Describe the documentation problem and suggest improvements
+      placeholder: |
+        Example: The nox session documentation is missing examples for Rust projects...
     validations:
       required: true
 
   - type: input
     id: link
     attributes:
-      label: Link
-      description: Link to the existing documentation (if applicable)
-      placeholder: ex. https://cookiecutter-robust-python.readthedocs.io/en/latest/...
+      label: 🔗 Documentation Link
+      description: Link to the problematic documentation (if applicable)
+      placeholder: https://cookiecutter-robust-python.readthedocs.io/en/latest/...
     validations:
       required: false
 
   - type: dropdown
     id: issue_type
     attributes:
-      label: Issue type
+      label: 🏷️ Issue Type
       options:
         - Missing documentation
         - Incorrect/outdated information
@@ -63,7 +68,9 @@ body:
   - type: textarea
     id: suggested_improvement
     attributes:
-      label: Suggested improvement
-      description: How should this documentation be improved?
+      label: ✨ Suggested Improvement
+      description: How can this documentation be improved? What would you like to see added or changed?
+      placeholder: |
+        Example: Add a section showing how to customize the nox configuration for different project types...
     validations:
       required: false