Skip to content

docs: add structured bug report issue template#1158

Merged
LalatenduMohanty merged 1 commit into
python-wheel-build:mainfrom
ryanpetrello:add-bug-report-template
May 14, 2026
Merged

docs: add structured bug report issue template#1158
LalatenduMohanty merged 1 commit into
python-wheel-build:mainfrom
ryanpetrello:add-bug-report-template

Conversation

@ryanpetrello
Copy link
Copy Markdown
Contributor

@ryanpetrello ryanpetrello commented May 14, 2026

What

Adds .github/ISSUE_TEMPLATE/bug_report.yml — a structured bug report form with two required sections:

  • Environment — prefilled with Fromager version, Python version, OS/arch, container/local
  • Bug description — prefilled prompts for expected behavior, actual behavior, and logs

Auto-applies the bug label and sets a [Bug]: title prefix.

Why

Closes #967 — freeform bug reports often miss critical details needed to reproduce failures.

@ryanpetrello ryanpetrello requested a review from a team as a code owner May 14, 2026 19:52
@mergify mergify Bot added the ci label May 14, 2026
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 14, 2026

Review Change Stack

📝 Walkthrough

Walkthrough

This PR adds a structured GitHub issue template at .github/ISSUE_TEMPLATE/bug_report.yml for bug reporting in the fromager project. The template defines required fields for package details, build stage, fromager version, command run, and expected/actual behavior, along with optional fields for error output, package settings, constraints, and environment information. The template auto-applies the bug label to created issues and uses appropriate renderers (shell for logs, YAML for settings).

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 4
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the main change: adding a structured bug report issue template to the documentation.
Linked Issues check ✅ Passed The PR fully implements all required fields and features from issue #967: all 11 fields present, build-step dropdown with correct options, auto-applied bug label, proper render types (shell/yaml), and environment prefill with required variables.
Out of Scope Changes check ✅ Passed The PR contains only the single file addition (.github/ISSUE_TEMPLATE/bug_report.yml) directly required by issue #967; no extraneous changes detected.
Description check ✅ Passed The pull request description clearly explains what (a bug report template) and why (to collect critical details for reproducible bug reports, closing #967).

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Adds a structured GitHub issue form for bug reports with environment
details and a prefilled description guiding reporters to include
expected behavior, actual behavior, and logs.

Co-Authored-By: Claude <claude@anthropic.com>
Closes: python-wheel-build#967
Signed-off-by: Ryan Petrello <rpetrell@redhat.com>
@ryanpetrello ryanpetrello force-pushed the add-bug-report-template branch from 3271132 to 474da3c Compare May 14, 2026 20:03
@ryanpetrello
Copy link
Copy Markdown
Contributor Author

For reviewers, here's a preview of the form:

https://github.com/ryanpetrello/fromager/issues/new?template=bug_report.yml

@LalatenduMohanty LalatenduMohanty merged commit ef797e4 into python-wheel-build:main May 14, 2026
39 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add structured bug report issue template (.github/ISSUE_TEMPLATE/bug_report.yml)

4 participants