From 285f4da659dc67926499ace51dfa02d7cf693ae3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Edwin=20Carre=C3=B1o?= Date: Fri, 28 Nov 2025 13:17:14 +0100 Subject: [PATCH 1/5] feat: add bug report template --- .github/ISSUE_TEMPLATE/a_bug_report.yaml | 47 ++++++++++++++++++++++++ 1 file changed, 47 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/a_bug_report.yaml diff --git a/.github/ISSUE_TEMPLATE/a_bug_report.yaml b/.github/ISSUE_TEMPLATE/a_bug_report.yaml new file mode 100644 index 0000000..299ca70 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/a_bug_report.yaml @@ -0,0 +1,47 @@ +name: Bug Report +description: Report a problem with the cookiecutter template or the generated project. +title: '[BUG] ' +labels: [bug] +body: +- type: textarea + id: description + attributes: + label: Description + description: Describe the bug clearly and concisely. + placeholder: What happened? + validations: + required: true + +- type: textarea + id: reproduce + attributes: + label: Steps to Reproduce + description: Provide all steps, including Cookiecutter prompts. + placeholder: | + 1. + 2. + 3. + validations: + required: true + +- type: textarea + id: expected + attributes: + label: Expected Behavior + description: Describe what you expected to happen. + validations: + required: true + +- type: textarea + id: actual + attributes: + label: Actual Behavior / Logs + description: Include error messages, stack traces, or relevant output. + render: shell + +- type: input + id: environment + attributes: + label: Environment + description: Python version, OS, Cookiecutter version. + placeholder: Python 3.12.1, Ubuntu 22.04, Cookiecutter 2.3 From eb4a57ead496cf1da8e4e58d06503ed2358df9e4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Edwin=20Carre=C3=B1o?= Date: Fri, 28 Nov 2025 13:19:15 +0100 Subject: [PATCH 2/5] feat: add feature request template --- .github/ISSUE_TEMPLATE/b_feature_request.yaml | 39 +++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/b_feature_request.yaml diff --git a/.github/ISSUE_TEMPLATE/b_feature_request.yaml b/.github/ISSUE_TEMPLATE/b_feature_request.yaml new file mode 100644 index 0000000..f58d44a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/b_feature_request.yaml @@ -0,0 +1,39 @@ +name: Feature Request +description: Suggest an improvement for the Cookiecutter template. +title: "[Feature] " +labels: [enhancement] +body: + - type: textarea + id: summary + attributes: + label: Summary + description: Describe the feature you propose. + placeholder: What should be added or improved? + validations: + required: true + + - type: textarea + id: benefits + attributes: + label: Rationale + description: Why is this feature valuable? How will users benefit? + validations: + required: true + + - type: textarea + id: design + attributes: + label: Proposed Design + description: Describe how the feature could be implemented. Include template variables, folder layout changes, etc. + + - type: textarea + id: compatibility + attributes: + label: Backward Compatibility + description: Could this change break existing generated projects? + + - type: textarea + id: alternatives + attributes: + label: Alternatives + description: Are there other solutions or approaches? From eab304e3ee2b973d55275572a55bef995b62ea3f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Edwin=20Carre=C3=B1o?= Date: Fri, 28 Nov 2025 13:20:55 +0100 Subject: [PATCH 3/5] feat: add cookiecutter request template --- .../c_cookiecutter_request.yaml | 36 +++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/c_cookiecutter_request.yaml diff --git a/.github/ISSUE_TEMPLATE/c_cookiecutter_request.yaml b/.github/ISSUE_TEMPLATE/c_cookiecutter_request.yaml new file mode 100644 index 0000000..fd41334 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/c_cookiecutter_request.yaml @@ -0,0 +1,36 @@ +name: Cookiecutter Option Request +description: Propose a new Cookiecutter variable or configuration option. +title: "[Option] " +labels: [enhancement, cookiecutter] +body: + - type: input + id: option_name + attributes: + label: Option Name + placeholder: e.g., enable_fastapi + validations: + required: true + + - type: textarea + id: purpose + attributes: + label: Purpose + description: Why should this option exist? + + - type: textarea + id: default + attributes: + label: Default Value + placeholder: "true / false / string" + + - type: textarea + id: impact + attributes: + label: Impact on Template + description: What directories, files, or hooks would be affected? + + - type: textarea + id: implementation + attributes: + label: Suggested Implementation + description: Optional but helpful. From 04d16de0e7b4c78dcdeebc1bad1303a6d25b6990 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Edwin=20Carre=C3=B1o?= Date: Fri, 28 Nov 2025 13:22:50 +0100 Subject: [PATCH 4/5] feat: add documentation issue template --- .github/ISSUE_TEMPLATE/d_documentation.yaml | 28 +++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/d_documentation.yaml diff --git a/.github/ISSUE_TEMPLATE/d_documentation.yaml b/.github/ISSUE_TEMPLATE/d_documentation.yaml new file mode 100644 index 0000000..d3c63ce --- /dev/null +++ b/.github/ISSUE_TEMPLATE/d_documentation.yaml @@ -0,0 +1,28 @@ +name: Documentation Improvement +description: Suggest updates to the README or the generated project docs. +title: "[Docs] " +labels: [documentation] +body: + - type: textarea + id: scope + attributes: + label: Topic + description: What documentation needs improvement? + + - type: textarea + id: problem + attributes: + label: Problem + description: What is unclear, inaccurate, or missing? + + - type: textarea + id: solution + attributes: + label: Proposed Improvement + description: How should the documentation be improved? + + - type: textarea + id: references + attributes: + label: References + description: Add links or examples if applicable. From e0b1b7a2e55285c20a2d3516fcf1d51c3d679145 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Edwin=20Carre=C3=B1o?= Date: Fri, 28 Nov 2025 13:24:10 +0100 Subject: [PATCH 5/5] feat: add ux feedback template --- .github/ISSUE_TEMPLATE/e_ux_feddback.yaml | 28 +++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/e_ux_feddback.yaml diff --git a/.github/ISSUE_TEMPLATE/e_ux_feddback.yaml b/.github/ISSUE_TEMPLATE/e_ux_feddback.yaml new file mode 100644 index 0000000..b1e46eb --- /dev/null +++ b/.github/ISSUE_TEMPLATE/e_ux_feddback.yaml @@ -0,0 +1,28 @@ +name: Template UX Feedback +description: Provide feedback on usability and user experience of the template. +title: "[UX] " +labels: [feedback] +body: + - type: textarea + id: experience + attributes: + label: User Experience + description: Describe your experience generating a project. + + - type: textarea + id: prompts + attributes: + label: Cookiecutter Prompts + description: Were the prompts intuitive and clear? + + - type: textarea + id: pain_points + attributes: + label: Pain Points + description: What felt confusing, unnecessary, or complicated? + + - type: textarea + id: suggestions + attributes: + label: Suggestions + description: How can we improve the template experience?