Skip to content

Fix issue/feature templates: add version info, debug traces, and master comparison guidance#2077

Merged
tlaurion merged 1 commit intolinuxboot:masterfrom
tlaurion:fix-issue-feature-templates
Mar 18, 2026
Merged

Fix issue/feature templates: add version info, debug traces, and master comparison guidance#2077
tlaurion merged 1 commit intolinuxboot:masterfrom
tlaurion:fix-issue-feature-templates

Conversation

@tlaurion
Copy link
Copy Markdown
Collaborator

This pull request updates the GitHub issue templates to improve the quality and clarity of bug reports and feature requests. The main changes introduce clear instructions for users to check if their issue or request is already addressed in the latest master branch, require more precise version information, and emphasize the need for debug traces in bug reports. These updates help reduce duplicate reports and ensure maintainers receive all necessary information to triage issues efficiently.

Improvements to bug report templates:

  • Added a "Before filing a bug report" section to .github/ISSUE_TEMPLATE/bug-report-for-everything-except-build-errors.md instructing users to check if their issue is already fixed in the master branch and to contact vendors if needed.
  • Updated instructions to require the full version string (including git commit hash) from Options → System Information for more accurate version reporting.
  • Added a requirement for users to include debug/trace output in bug reports, with a link to instructions for capturing this output.

Improvements to build error report template:

  • Added a "Before filing a build error report" section to .github/ISSUE_TEMPLATE/bug-report-for-heads-build-errors.md with instructions to check for fixes in master before reporting.
  • Clarified version reporting by asking for the Heads/coreboot commit ID or tag, and where to find this information.

Improvements to feature request template:

  • Added a "Before filing a feature request" section to .github/ISSUE_TEMPLATE/feature_request.md instructing users to check if the feature is already implemented in master and to contact vendors if necessary.

Changes by co-poliot, signed-off by me

…er comparison guidance

Signed-off-by: Thierry Laurion <insurgo@riseup.net>
Copilot AI review requested due to automatic review settings March 18, 2026 15:55
@tlaurion tlaurion merged commit e36d84f into linuxboot:master Mar 18, 2026
3 checks passed
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR updates the repository’s GitHub issue templates to gather higher-quality bug reports and feature requests by adding pre-filing guidance (compare against master), requiring more precise version information, and requesting debug/trace output for bug reports.

Changes:

  • Added “Before filing …” sections to bug/build/feature templates with instructions to compare against master.
  • Tightened version-reporting instructions (full version string / commit hash, and Heads/coreboot commit/tag guidance).
  • Added a prominent requirement to include debug/trace output for non-build bug reports.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 4 comments.

File Description
.github/ISSUE_TEMPLATE/feature_request.md Adds pre-filing guidance and a master comparison link for feature requests.
.github/ISSUE_TEMPLATE/bug-report-for-heads-build-errors.md Adds pre-filing guidance and clarifies version info requested for build error reports.
.github/ISSUE_TEMPLATE/bug-report-for-everything-except-build-errors.md Adds pre-filing steps, updates board link, clarifies version reporting, and requires debug traces.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

You can also share your feedback on Copilot code review. Take the survey.

Comment on lines +17 to +18
- If the bug is already fixed in master, **please upgrade** to the latest release instead of filing a report.
- If you received your device from a vendor (Nitrokey, Insurgo, Purism, etc.) and the fix is in master but not in their release, **please file the bug with your vendor** so they can do a bugfix release.
**⚠️ Check if your feature is already implemented in master!**

Compare your version with the current [Heads master branch](https://github.com/linuxboot/heads/commits/master):
`https://github.com/linuxboot/heads/compare/<your-commit-hash>...master`
**⚠️ Check if your issue is already fixed in master!**

Compare your branch/commit with the current [Heads master branch](https://github.com/linuxboot/heads/commits/master):
`https://github.com/linuxboot/heads/compare/<your-commit-hash>...master`

**⚠️ Check if your issue is already fixed in master!**

1. Get your Heads version from the running system: go to **Options → System Information** and note the full version string (including git commit hash).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants