From 7e40c3869b343d381d6aa1f50a82306e92ed1eef Mon Sep 17 00:00:00 2001 From: mrizzi Date: Tue, 7 Jul 2026 09:46:01 +0200 Subject: [PATCH 1/2] docs: add GitHub Issue templates for bug reports and feature requests Add structured issue templates so external contributors can report bugs and propose features through GitHub Issues. Both templates include a triage note explaining that issues may be promoted to Jira for planning. Implements TC-5081 Assisted-by: Claude Code --- .github/ISSUE_TEMPLATE/bug-report.md | 40 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature-request.md | 26 +++++++++++++++ 2 files changed, 66 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug-report.md create mode 100644 .github/ISSUE_TEMPLATE/feature-request.md diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md new file mode 100644 index 00000000..c26dde4f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -0,0 +1,40 @@ +--- +name: Bug Report +about: Report a bug to help us improve +labels: bug +assignees: "" +--- + +## Description + +A clear and concise description of the bug. + +## Steps to Reproduce + +1. Run `...` +2. Invoke skill `...` +3. Observe `...` + +## Expected Behavior + +What you expected to happen. + +## Actual Behavior + +What actually happened. Include error messages, logs, or screenshots if available. + +## Plugin Version + +The version of sdlc-workflow you are using (check `plugins/sdlc-workflow/.claude-plugin/plugin.json`). + +## Claude Code Version + +The version of Claude Code you are running (`claude --version`). + +## Additional Context + +Any other context about the problem (e.g., OS, shell, MCP server configuration). + +--- + +> **Note:** Issues are triaged by maintainers and may be promoted to Jira for planning. diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md new file mode 100644 index 00000000..f7c1b79c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.md @@ -0,0 +1,26 @@ +--- +name: Feature Request +about: Suggest a new feature or improvement +labels: enhancement +assignees: "" +--- + +## Problem Statement + +A clear and concise description of the problem this feature would solve. + +## Proposed Solution + +How you envision the feature working (optional). + +## Alternatives Considered + +Any alternative approaches you have considered (optional). + +## Additional Context + +Any other context, examples, or references that help illustrate the request (optional). + +--- + +> **Note:** Issues are triaged by maintainers and may be promoted to Jira for planning. From a2e1365f5e7a303db97e24ff903db9fd0ec9fec6 Mon Sep 17 00:00:00 2001 From: mrizzi Date: Tue, 7 Jul 2026 10:04:47 +0200 Subject: [PATCH 2/2] docs: convert issue templates from markdown to YAML-based issue forms Replace markdown issue templates with GitHub issue forms (.yml) to enforce required fields at the UI level. Bug report now has separate structured fields for OS, shell, and MCP server configuration instead of free-form Additional Context. Both forms include the triage note in the top-level description. Implements TC-5097 Assisted-by: Claude Code --- .github/ISSUE_TEMPLATE/bug-report.md | 40 ----------- .github/ISSUE_TEMPLATE/bug-report.yml | 82 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature-request.md | 26 ------- .github/ISSUE_TEMPLATE/feature-request.yml | 32 +++++++++ 4 files changed, 114 insertions(+), 66 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug-report.md create mode 100644 .github/ISSUE_TEMPLATE/bug-report.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature-request.md create mode 100644 .github/ISSUE_TEMPLATE/feature-request.yml diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md deleted file mode 100644 index c26dde4f..00000000 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -name: Bug Report -about: Report a bug to help us improve -labels: bug -assignees: "" ---- - -## Description - -A clear and concise description of the bug. - -## Steps to Reproduce - -1. Run `...` -2. Invoke skill `...` -3. Observe `...` - -## Expected Behavior - -What you expected to happen. - -## Actual Behavior - -What actually happened. Include error messages, logs, or screenshots if available. - -## Plugin Version - -The version of sdlc-workflow you are using (check `plugins/sdlc-workflow/.claude-plugin/plugin.json`). - -## Claude Code Version - -The version of Claude Code you are running (`claude --version`). - -## Additional Context - -Any other context about the problem (e.g., OS, shell, MCP server configuration). - ---- - -> **Note:** Issues are triaged by maintainers and may be promoted to Jira for planning. diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 00000000..da301246 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,82 @@ +name: Bug Report +description: Report a bug to help us improve. Issues are triaged by maintainers and may be promoted to Jira for planning. +labels: [bug] +body: + - type: textarea + id: description + attributes: + label: Description + description: A clear and concise description of the bug. + validations: + required: true + - type: textarea + id: steps-to-reproduce + attributes: + label: Steps to Reproduce + description: Steps to reproduce the behavior. + placeholder: | + 1. Run `...` + 2. Invoke skill `...` + 3. Observe `...` + validations: + required: true + - type: textarea + id: expected-behavior + attributes: + label: Expected Behavior + description: What you expected to happen. + validations: + required: true + - type: textarea + id: actual-behavior + attributes: + label: Actual Behavior + description: What actually happened. Include error messages, logs, or screenshots if available. + validations: + required: true + - type: input + id: plugin-version + attributes: + label: Plugin Version + description: The version of sdlc-workflow (check `plugins/sdlc-workflow/.claude-plugin/plugin.json`). + placeholder: "0.12.2" + validations: + required: true + - type: input + id: claude-code-version + attributes: + label: Claude Code Version + description: The version of Claude Code you are running (`claude --version`). + placeholder: "1.0.0" + validations: + required: true + - type: input + id: operating-system + attributes: + label: Operating System + description: Your operating system and version. + placeholder: "macOS 15.1, Ubuntu 24.04, Windows 11" + validations: + required: false + - type: input + id: shell + attributes: + label: Shell + description: The shell you are using. + placeholder: "zsh, bash, PowerShell" + validations: + required: false + - type: textarea + id: mcp-server-configuration + attributes: + label: MCP Server Configuration + description: Any relevant MCP server configuration (e.g., configured servers, connection issues). + validations: + required: false + - type: textarea + id: additional-context + attributes: + label: Additional Context + description: Any other context about the problem. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md deleted file mode 100644 index f7c1b79c..00000000 --- a/.github/ISSUE_TEMPLATE/feature-request.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -name: Feature Request -about: Suggest a new feature or improvement -labels: enhancement -assignees: "" ---- - -## Problem Statement - -A clear and concise description of the problem this feature would solve. - -## Proposed Solution - -How you envision the feature working (optional). - -## Alternatives Considered - -Any alternative approaches you have considered (optional). - -## Additional Context - -Any other context, examples, or references that help illustrate the request (optional). - ---- - -> **Note:** Issues are triaged by maintainers and may be promoted to Jira for planning. diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml new file mode 100644 index 00000000..c57fded7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -0,0 +1,32 @@ +name: Feature Request +description: Suggest a new feature or improvement. Issues are triaged by maintainers and may be promoted to Jira for planning. +labels: [enhancement] +body: + - type: textarea + id: problem-statement + attributes: + label: Problem Statement + description: A clear and concise description of the problem this feature would solve. + validations: + required: true + - type: textarea + id: proposed-solution + attributes: + label: Proposed Solution + description: How you envision the feature working. + validations: + required: false + - type: textarea + id: alternatives-considered + attributes: + label: Alternatives Considered + description: Any alternative approaches you have considered. + validations: + required: false + - type: textarea + id: additional-context + attributes: + label: Additional Context + description: Any other context, examples, or references that help illustrate the request. + validations: + required: false