Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[GH] Issue and Improvement templates #8795

Closed
ferdymercury opened this issue Aug 4, 2021 · 4 comments · Fixed by #10366
Closed

[GH] Issue and Improvement templates #8795

ferdymercury opened this issue Aug 4, 2021 · 4 comments · Fixed by #10366

Comments

@ferdymercury
Copy link
Collaborator

ferdymercury commented Aug 4, 2021

Explain what you would like to see improved

In the GitHub templates for "Issue" and "Improvement", I think it could be interesting to replace these instructions

### Setup
<!--
1. ROOT version
2. Operating system
3. How you obtained ROOT, such as `dnf install` / binary download / you built it yourself.
-->

with:

### Setup
'''
Suggested: Paste here the output of root -b -q
'''

(Maybe some more metadata had to be added to root -b in order to tag some builds as 'dnf' or 'binary prepackage'.)

It would be interesting to define a special command in the ROOT binary folder, like
rootissue or rootfeature that opens a web browser with an issue or feature template, with the field "Setup" already prepopulated with the current ROOT version. See below how KiCad does this.

Additional context

KiCad already has this functionality. When one presses on "Report Bug" in the KiCaD GUI, it opens a webpage pre-filled with the version field, see https://gitlab.com/kicad/code/kicad/-/blob/master/common/tool/common_control.cpp#L50. It just opens a web browser with the following link, that looks like this:

image

This homogenizes bug reports and saves time of the dev's asking what their current settings and versions are.

The KiCad gitlab bot also warns the user if it detects that no version info was added to the issue.

And they have a very nice webpage to aid users in reporting issues at the right repository: https://www.kicad.org/help/report-an-issue/

@ferdymercury ferdymercury changed the title [GH] issue and improvement templates [GH] Issue and Improvement templates Aug 4, 2021
@eguiraud
Copy link
Member

eguiraud commented Aug 9, 2021

@Axel-Naumann does the discussion at #8805 imply that this issue can be closed?

@ferdymercury
Copy link
Collaborator Author

ferdymercury commented Aug 9, 2021

Side note: my suggestion was to make contributions less of a burocratic pain, not more ;)
For me, it takes more time to write the ROOT version and Operating System by hand like now, rather than copying root -b output, or to just call in the terminal "rootissue" which already prefills all fields and opens the browser.

@Axel-Naumann
Copy link
Member

Replacing one by the other seems fine to me. I don't want our users to go through additional steps, and I'd like to keep this welcoming (i.e. no all caps "must" etc). I like the idea of having a tool that spits out version, platform, built-by / -machine / -directory which would allow us to guess whether it's Conda, a nightly, a custom build, or whatever.

@ferdymercury
Copy link
Collaborator Author

ferdymercury commented Mar 5, 2022

of having a tool that spits out version, platform, built-by / -machine / -directory which would allow us to guess whether it's Conda, a nightly, a custom build, or whatever.

Another option instead of a "rootissue.exe" would be to create a custom ROOT prompt command,
".issue"
that does this part.
(Instead of adding a new executable).

In the same way that .help TTree opens a web browser.

ferdymercury added a commit to ferdymercury/root that referenced this issue Apr 8, 2022
ferdymercury added a commit to ferdymercury/root that referenced this issue May 10, 2022
ferdymercury added a commit to ferdymercury/root that referenced this issue Sep 27, 2022
ferdymercury added a commit to ferdymercury/root that referenced this issue Dec 9, 2022
@ferdymercury ferdymercury added this to Issues in Fixed in 6.28/06 via automation Jun 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
No open projects
3 participants