github: Add `config.yml` for GUI issues #21870

ghost commented at 9:14 AM on May 6, 2021: none

Redirect users to create a blank issue in bitcoin-core/gui

Before this PR:

After this PR:

michaelfolkson commented at 9:37 AM on May 6, 2021: contributor

So the problem here (I think) is that the Core repo and the GUI repo have to share the same issue templates. As @MarcoFalke states here the GUI repo is a monotree. So any change made to the issue templates in the main repo must also be somewhat effective for the GUI repo. And vice versa, any change made to the issue templates in the GUI repo must be somewhat effective for the main repo.

I agree that having an issue template referring to the GUI in addition to other templates not referring to the GUI in the GUI repo is suboptimal. But (I think) how it is currently set up is as good as we can get due to the monotree setup. The most important thing is that people know to go from the main repo to the GUI repo to open a GUI issue without prompting from reviewers. I think this is as clear as we can get with the current setup without worsening the issue opening experience further on one of the two repos.

Thanks for trying to improve this experience. I'm happy to be corrected if you find a way of improving the issue opening experience on one repo without worsening the issue opening experience on the other repo :)

DrahtBot added the label Docs on May 6, 2021

ghost commented at 10:34 AM on May 6, 2021: none

The most important thing is that people know to go from the main repo to the GUI repo to open a GUI issue without prompting from reviewers. I think this is as clear as we can get with the current setup without worsening the issue opening experience further on one of the two repos.

I am not sure if this is ACK or NACK for this PR.

So the problem here (I think) is that the Core repo and the GUI repo have to share the same issue templates. As @MarcoFalke states here the GUI repo is a monotree.

Yes we don't need GUI issue template in GUI repo but it will be there because of this setup. This PR just changes the option users had for creating issue in GUI repo earlier. Makes it easier and involves less steps.

User is not aware of GUI repo, tries to create an issue in this repo about something wrong with GUI
Finds last option for GUI in templates
Clicks on "open" and creates an issue in GUI repo

in .github/ISSUE_TEMPLATE/config.yml:5 in fa83808351 outdated

   0 | @@ -0,0 +1,5 @@
   1 | +blank_issues_enabled: true
   2 | +contact_links:
   3 | +  - name: "An issue or feature request related to the GUI"
   4 | +    url: https://github.com/bitcoin-core/gui/issues/new
   5 | +    about: The 'bitcoin-core/gui' repository is used exclusively for the development of the GUI. Its master branch is identical in all monotree repositories. Release branches and tags do not exist, so please do not fork that repository unless it is for development reasons.

MarcoFalke commented at 10:47 AM on May 6, 2021:

Why is the "about" text changed?

michaelfolkson commented at 10:56 AM on May 6, 2021:

Before the "about" was:

Any report, issue or feature request related to the GUI should be reported at https://github.com/bitcoin-core/gui/issues/

Before this change someone seeking to open a GUI issue but who starts in the main repo would need to manually enter the GUI repo URL to go to the correct repo. After this change that person is automatically redirected to the GUI repo when clicking on the new GUI issue button from within the main repo. So that person would no longer need to be told to go to that URL in the "about". That is the motivation for changing it (I think without commenting on what the "about" is changed to).

unknown commented at 11:03 AM on May 6, 2021:

@michaelfolkson yes old "about" text doesn't make sense after this change because we have created a link for redirection @MarcoFalke I copied the new "about" from 2nd paragraph in https://github.com/bitcoin/bitcoin/#development-process

unknown commented at 5:02 PM on June 2, 2021:

Changed about text and squashed commits to https://github.com/bitcoin/bitcoin/commit/417ba29c0232cb04bab4b6d02ce039d5ff40127b

michaelfolkson commented at 10:49 AM on May 6, 2021: contributor

I am not sure if this is ACK or NACK for this PR.

So I think this change improves the experience of someone seeking to open a GUI issue but who starts in the main repo and needs to be redirected to the GUI repo, agreed.

And I don't think it worsens the experience of someone seeking to open a GUI issue but who starts in the GUI repo (ie the correct repo for them).

So therefore I think it is a Concept ACK from me.

laanwj renamed this:
~~Add `config.yml`~~
github: Add `config.yml` for GUI issues
on May 13, 2021

Add `config.yml`

+ Remove `gui_issue` old template
+ Redirect users to create a blank issue in `bitcoin-core/gui`

417ba29c02

MarcoFalke commented at 7:22 AM on June 3, 2021: member

ACK 417ba29c0232cb04bab4b6d02ce039d5ff40127b fine by me, but I haven't tested

unknown closed this on Jul 12, 2021

in .github/ISSUE_TEMPLATE/config.yml:4 in 417ba29c02

   0 | @@ -0,0 +1,5 @@
   1 | +blank_issues_enabled: true
   2 | +contact_links:
   3 | +  - name: "An issue or feature request related to the GUI"
   4 | +    url: https://github.com/bitcoin-core/gui/issues/new

MarcoFalke commented at 7:14 AM on July 13, 2021:

url should be like it was previously (https://github.com/bitcoin-core/gui/issues/), or include the /new/choose suffix to allow choosing a template

DrahtBot locked this on Aug 18, 2022