Skip to content

feat(report-bug): add Environment/Version required section to default bug template#247

Merged
mrizzi merged 1 commit into
RHEcosystemAppEng:mainfrom
mrizzi:worktree-TC-5311
Jul 21, 2026
Merged

feat(report-bug): add Environment/Version required section to default bug template#247
mrizzi merged 1 commit into
RHEcosystemAppEng:mainfrom
mrizzi:worktree-TC-5311

Conversation

@mrizzi

@mrizzi mrizzi commented Jul 21, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • Add "Environment / Version" row to the Required Sections table in the default bug template (docs/templates/bug-template.md)
  • The new section is placed after "Actual Result" and before "Attachments", prompting users to provide product version, deployment method, and affected area
  • Since the report-bug skill is data-driven from the template table, this change automatically makes the skill prompt for the new section — no SKILL.md changes needed

Implements TC-5311

Test Plan

  • Template renders correctly in Markdown with the new row
  • Report-bug skill picks up the new section without SKILL.md changes (data-driven validation confirmed by reading SKILL.md Step 3a)

Summary by Sourcery

Documentation:

  • Add Environment / Version as a required section in the default bug report template between Actual Result and Attachments.

… 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
@sourcery-ai

sourcery-ai Bot commented Jul 21, 2026

Copy link
Copy Markdown
Contributor
Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Adds 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 section

sequenceDiagram
    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
Loading

File-Level Changes

Change Details Files
Introduce a new required Environment / Version section in the default bug template so bug reports capture product version and deployment context.
  • Extend the Required Sections Markdown table with an Environment / Version row positioned between Actual Result and Attachments.
  • Align the new section with the existing heading convention using the ### **Environment / Version** format so template-driven automation can detect it.
  • Ensure the change is purely in the template, relying on the existing data-driven report-bug skill to consume the new section without SKILL.md updates.
docs/templates/bug-template.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@mrizzi

mrizzi commented Jul 21, 2026

Copy link
Copy Markdown
Collaborator Author

Verification Report for TC-5311 (commit 3bc22f4)

Check Result Details
Review Feedback N/A No review comments on this PR
Root-Cause Investigation N/A No sub-tasks created
Scope Containment PASS PR modifies exactly the file specified in the task
Diff Size PASS 1 addition in 1 file — proportionate to single-row table addition
Commit Traceability PASS Commit references TC-5311 in body
Sensitive Patterns PASS No sensitive patterns detected
CI Status PASS All 3 checks pass (Plugin Validation, Skill Lint, Sourcery)
Acceptance Criteria FAIL 1 of 2 criteria met — content guidance for product version and affected area is not explicitly documented
Test Quality N/A No test files in PR; Eval Quality: N/A
Test Change Classification N/A No test files in PR
Verification Commands N/A No verification commands specified

Overall: FAIL

Acceptance 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 | Environment / Version | ### Environment / Version | with no accompanying content guidance text. The report-bug skill's SKILL.md instructs the agent to "State the section name and explain what kind of input is expected" but provides no specific guidance for this section. Existing sections (Description, Steps to Reproduce, etc.) also lack explicit content guidance, relying on self-explanatory section names — however, the acceptance criteria explicitly require content guidance for this new section.


This comment was AI-generated by sdlc-workflow/verify-pr v0.13.2.

@mrizzi

mrizzi commented Jul 21, 2026

Copy link
Copy Markdown
Collaborator Author

Verification Report for TC-5311 (commit 3bc22f4) — Corrected

Check Result Details
Review Feedback N/A No review comments on this PR
Root-Cause Investigation N/A No sub-tasks created
Scope Containment PASS PR modifies exactly the file specified in the task
Diff Size PASS 1 addition in 1 file — proportionate to single-row table addition
Commit Traceability PASS Commit references TC-5311 in body
Sensitive Patterns PASS No sensitive patterns detected
CI Status PASS All 3 checks pass (Plugin Validation, Skill Lint, Sourcery)
Acceptance Criteria WARN 2 of 2 criteria met — criterion 2 satisfied indirectly via section name as content guidance
Test Quality N/A No test files in PR; Eval Quality: N/A
Test Change Classification N/A No test files in PR
Verification Commands N/A No verification commands specified

Overall: WARN

Acceptance 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.

@mrizzi
mrizzi merged commit 394cc9b into RHEcosystemAppEng:main Jul 21, 2026
3 checks passed
@mrizzi
mrizzi deleted the worktree-TC-5311 branch July 21, 2026 16:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant