Skip to content

Commit c93e8a2

Browse files
Copilottlaurion
authored andcommitted
Fix issue/feature templates: add version info, debug traces, and master comparison guidance
Signed-off-by: Thierry Laurion <insurgo@riseup.net>
1 parent 2ab9ff3 commit c93e8a2

3 files changed

Lines changed: 49 additions & 5 deletions

File tree

.github/ISSUE_TEMPLATE/bug-report-for-everything-except-build-errors.md

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,23 @@ assignees: ''
77

88
---
99

10+
## Before filing a bug report
11+
12+
**⚠️ Check if your issue is already fixed in master!**
13+
14+
1. Get your Heads version from the running system: go to **Options → System Information** and note the full version string (including git commit hash).
15+
2. Compare your version with the current [Heads master branch](https://github.com/linuxboot/heads/commits/master). You can check the diff at:
16+
`https://github.com/linuxboot/heads/compare/<your-commit-hash>...master`
17+
- If the bug is already fixed in master, **please upgrade** to the latest release instead of filing a report.
18+
- 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.
19+
20+
---
21+
1022
## Please identify some basic details to help process the report
1123

1224
### A. Provide Hardware Details
1325

14-
1. What board are you using? (Choose from the list of boards [here](https://github.com/eganonoa/heads/tree/master/boards))
26+
1. What board are you using? (Choose from the list of boards [here](https://github.com/linuxboot/heads/tree/master/boards))
1527

1628
2. Does your computer have a dGPU or is it iGPU-only?
1729
- [ ] dGPU (Distinct GPU other then internal GPU)
@@ -87,8 +99,9 @@ assignees: ''
8799
- [ ] Heads:Master
88100
- [ ] Other (please identify)
89101

90-
4. What version of coreboot did you use in building?
91-
{ You can find this information from github commit ID or once flashed, by giving the complete version from Sytem Information under Options --> menu}
102+
4. What version of Heads/coreboot are you running?
103+
- Navigate to **Options → System Information** on the running device and paste the **full version string** here (including the git commit hash).
104+
- Alternatively, provide the GitHub commit ID if building from source.
92105

93106
5. In building the rom, where did you get the blobs?
94107
- [ ] No blobs required
@@ -100,6 +113,13 @@ assignees: ''
100113

101114
## Please describe the problem
102115

116+
**⚠️ Debug traces are required for all bug reports!**
117+
118+
Before filling in the details below, please capture debug/trace output from Heads. Follow the instructions at:
119+
👉 https://osresearch.net/Porting/#enabling-debug--trace-from-heads-gui
120+
121+
Paste the debug output in the **Additional context** section below (or attach as a file).
122+
103123
**Describe the bug**
104124
A clear and concise description of what the bug is.
105125

.github/ISSUE_TEMPLATE/bug-report-for-heads-build-errors.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,17 @@ assignees: ''
77

88
---
99

10+
## Before filing a build error report
11+
12+
**⚠️ Check if your issue is already fixed in master!**
13+
14+
Compare your branch/commit with the current [Heads master branch](https://github.com/linuxboot/heads/commits/master):
15+
`https://github.com/linuxboot/heads/compare/<your-commit-hash>...master`
16+
17+
If the bug is already fixed in master, please update your branch before filing a report.
18+
19+
---
20+
1021
## Context of the Build
1122

1223
**1. What board are you trying to build?**
@@ -15,8 +26,9 @@ assignees: ''
1526
- [ ] Heads:Master
1627
- [ ] Other (please specify)
1728

18-
**3. What version of coreboot are you trying to build**
19-
<!-- Please provide GitHub commit ID, or if firmware flashed, the information found under System Information for version -->
29+
**3. What version of Heads/coreboot are you trying to build?**
30+
<!-- Please provide the GitHub commit ID or tag (e.g. v2.0.0).
31+
If firmware is already flashed, this information is available under Options → System Information. -->
2032

2133
**4. In building the rom where did you get the blobs?**
2234
- [ ] No blobs required

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,18 @@ assignees: ''
77

88
---
99

10+
## Before filing a feature request
11+
12+
**⚠️ Check if your feature is already implemented in master!**
13+
14+
Compare your version with the current [Heads master branch](https://github.com/linuxboot/heads/commits/master):
15+
`https://github.com/linuxboot/heads/compare/<your-commit-hash>...master`
16+
17+
- If the feature already exists in master but not in your vendor's release, **please ask your vendor** to include it in their next release.
18+
- Check your current Heads version via **Options → System Information**.
19+
20+
---
21+
1022
**Is your feature request related to a problem? Please describe.**
1123
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
1224

0 commit comments

Comments
 (0)