feat(report-bug): add Environment/Version required section to default bug template#247
Conversation
… bug template Add an "Environment / Version" row to the Required Sections table in the default bug template. The new section is placed after "Actual Result" and before "Attachments", prompting users to provide product version, deployment method, and affected area when filing bugs. Since the report-bug skill is data-driven from the template table, this change automatically makes the skill prompt for the new section during interactive mode and validate its presence in programmatic mode. Implements TC-5311 Assisted-by: Claude Code
Reviewer's guide (collapsed on small PRs)Reviewer's GuideAdds a new required "Environment / Version" section to the default bug report template so the report-bug skill will automatically prompt for environment/version details without further skill configuration changes. Sequence diagram for report-bug skill using new Environment/Version sectionsequenceDiagram
actor User
participant ReportBugSkill
participant BugTemplate
User->>ReportBugSkill: invoke_report_bug
ReportBugSkill->>BugTemplate: load_bug_template
BugTemplate-->>ReportBugSkill: required_sections (including Environment_Version)
ReportBugSkill->>ReportBugSkill: validate_required_sections
ReportBugSkill->>User: prompt_for_Actual_Result
ReportBugSkill->>User: prompt_for_Environment_Version
ReportBugSkill->>User: prompt_for_Attachments
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
Verification Report for TC-5311 (commit 3bc22f4)
Overall: FAILAcceptance Criteria — Criterion 2 failure: The acceptance criteria require "the section content guidance includes at minimum: product version and affected area (installation, API, UI, data, etc.)." The PR adds only the table row This comment was AI-generated by sdlc-workflow/verify-pr v0.13.2. |
Verification Report for TC-5311 (commit 3bc22f4) — Corrected
Overall: WARNAcceptance Criteria — Criterion 2 (WARN): The criterion requires "content guidance includes at minimum: product version and affected area." The template format has no mechanism for explicit per-section content guidance — all existing sections (Description, Steps to Reproduce, etc.) rely on the section name being self-explanatory. The section name "Environment / Version" conveys both product version and affected area, satisfying the criterion's intent indirectly. Downgraded from FAIL to WARN per reviewer assessment. This comment was AI-generated by sdlc-workflow/verify-pr v0.13.2. |
Summary
docs/templates/bug-template.md)Implements TC-5311
Test Plan
Summary by Sourcery
Documentation: