root-project
[GH] Issue Template Fine-Tuning
Explain what you would like to see improved
After https://github.com/root-project/root/pull/10366 was merged, there were some further ideas to fine tune the GitHub issue templates. I leave them here for the record.
- [ ] Backtrace. (For example, when ROOT crashes and prints the stacktrace, there could be an option to forward it to a specific textarea in the YML template.)
- [x] Should we add three backquotes before and after GetSetup() so that it is formatted as monospace when filling ROOT version?
- [ ] Name of the build machine. (I don't know how else to figure out whether it's one of our binaries, a package, or built by the user? Iirc that's not available right now? Actually not related to build method, so not too useful)
- [ ] OS name
- [ ] ROOT-version prepopulated textarea contains also information that might fit better in other textarea. Should we split? or remove the dupe textarea?
- [x] Update on web full list of commands, add .gh issue, do as in update help message https://github.com/root-project/web/pull/776 https://github.com/root-project/web/pull/864
- [ ] Recommend also on ROOT manual these commands
- [ ] Maybe add similar instruction on main ROOT webpage as https://www.kicad.org/help/report-an-issue/
- [x] Mention in the Forum --> Done by Bertrand
- [ ] Add aliases (see below)? ++ update web/manual to reflect this
Share how it could be improved
No response
How to reproduce?
The way to submit a bug report without opening ROOT by hand would be:
root -b -e '.gh bug' -q
root -b -e '.gh feature' -q
root -b -e '.gh improvement' -q
root -b -e '.forum bug' -q
Not sure if it's worth to define an alias to these commands, in a similar fashion to rootbrowse, etc. For example:
rootbug
rootfeature
rootimprovement
rootforum
ROOT version
ROOT v6.29/01
Built for linuxx8664gcc on Jun 20 2023, 17:02:12
From heads/ghissue@v6-23-01-RF-binSampling-8983-g6aec26bfaf
With g++ (Ubuntu 11.3.0-1ubuntu1~22.04.1) 11.3.0
Binary directory: /home/user/build/build-root-Desktop-Debug/bin
How did you install ROOT?
Custom build
Which operating system are you using?
Ubuntu 22.04
Additional context
No response
Backticks around the output of GetSetup have been added in #13065 .
The hostname of the machine where ROOT was built in general does not say much w.r.t. how ROOT was installed, but I don't think it's so bad if the user has to provide that information themselves.
Since this is also related to external contributions, I add @enirolf in the loop as assignee.
Adding one more idea: @vgvassilev rightly suggests to reduce the number of fields that are mandatory (or duplicated). See https://github.com/root-project/root/issues/14781#issue-2145159615