Remove info about patch naming convention in issue template

Created on 23 April 2025, 28 days ago

Problem/Motivation

You get this message, when you create a new issue:

  • ALERT: ---> Please use the Issue Summary Template to report an issue, if you need help to understand how the issue queue works, .
  • If you go to provide a patch use the following naming convention :

    admin_toolbar-[short-description]-[issue-number]-[comment-number]-[drupal-version].patch

But Drupal has switched to GitLab MR based workflow, so the patch format sentence can be removed.

Also, the HTML sections from the issue template page are already included, so do we need to show a link to the "Issue Summary Template" page?

The video link is also dead ...

Steps to reproduce

Create an issue, and see that there is:

  1. A link to the Issue Summary Template page, but the HTML and headers are already included in the "Issue summary" field right below
  2. Patch info, though it has been phased out.
  3. Linked to video, but it's a dead URL

Proposed resolution

Decide if the entire info block should be remove, or some elements should stay?

  1. Remove patch format info
  2. Remove Link to the Issue Summary Template page?
  3. Remove link to video?

Remaining tasks

User interface changes

API changes

Data model changes

📌 Task
Status

Active

Version

3.0

Component

Miscellaneous

Created by

🇩🇰Denmark ressa Copenhagen

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Comments & Activities

  • Issue created by @ressa
  • 🇩🇰Denmark ressa Copenhagen
  • 🇫🇷France dydave

    Great catch @ressa!

    But unfortunately, I don't have enough permissions to edit the project page 😭
    I would need to be able to edit the project page to handle quite a few other documentation related tasks as well 😅

    As for the message itself:
    At the very least, the patching part should be removed, since officially: "we are only accepting merge requests".

    What about replacing the current block with the following one?

    Thank you very much for your interest in the Admin Toolbar module.
    We greatly appreciate your feedback, reporting, merge requests and tickets that could help improving the module.
    For a good example of how to post an issue, feel free to take a look at Issue Summary Template standards.

    Any comments, suggestions, testing, reporting, feedback, patches, ideas, features requests would be highly appreciated.
    Thanks again for your time.

    I might have to go back to Romain and ask for help on this one if we would really want to keep this moving along...
    So I could get the necessary level of access to change these fields.

    Any additional feedback, comments or suggestions would be greatly appreciated.
    Thanks in advance!

  • 🇩🇰Denmark ressa Copenhagen

    Great suggestion @dydave! I think it might be slimmed down a bit, to not push the form too far down ... Perhaps something like this could work?

    Thank you very much for your interest in the Admin Toolbar module, we greatly appreciate your feedback. See the Issue Summary template for tips on how to post a great issue.

    Comments, suggestions, testing, bug reports, feedback, patches, ideas, and feature requests are highly appreciated. Thanks again for your time.

    After all your efforts recently with the module, you have proven to be a very diligent and thorough Drupal contributor, and it would be a natural progression to grant you the "Maintainer" role, so you don't have obstacles, allowing you to update the project page, and other important tasks, such as documentation.

    So I hope Romain will consider elevating your permissions, so that the progress will not stall in some areas (project page, documentation), while moving ahead in others (module features) with light speed! 🚀

  • 🇨🇦Canada adriancid Montreal, Canada

    Thanks, done!

  • 🇩🇰Denmark ressa Copenhagen

    Great, thanks @adriancid!

    I would like to nominate @DYdave to get the "Maintainer" role, since it would make his job maintaining Admin Toolbar easier, and allow him to be more efficient. I hope you and @romainj would consider this. Like I wrote he has proven himself to be:

    [...] a very diligent and thorough Drupal contributor, and it would be a natural progression to grant you the "Maintainer" role, so you don't have obstacles, allowing you to update the project page, and other important tasks, such as documentation.

  • 🇨🇦Canada adriancid Montreal, Canada

    @ressa, I gave @dydave access to edit the project page; he can make all the tasks now for the module.

  • 🇫🇷France dydave

    Thank you very much @ressa for bringing this point up and all the kind words, once again, and Adrian (@adriancid) for granting me the necessary permissions to edit the project page, it's greatly appreciated! 🙏

    I have checked and indeed, I now seem to be able to properly edit the project page ✅

    I should be able to help handling any of the other documentation related issues 👌

    The create issue page now shows the updated message as suggested by @ressa above at #4 🥳

    We should now be able to move forward with the other issues!
    Thank you very much for your great help! 🙏

  • 🇩🇰Denmark ressa Copenhagen

    Well, you certainly deserve the nice words @dydave, with all the work you have done recently, getting Admin Toolbar in tip top shape :)

    And thanks @adriancid, that's great! My nomination for Maintainer role for @dydave does still stand. But it's not so important, as long as there are no obstacles for @dydave to perform the required tasks to work on Admin Toolbar -- more or less being functionally "Maintainer", all but by role.

    Big thanks to both of you for graciously donating your time to maintain this essential Drupal tool, and expanding it with new functionalities.

Production build 0.71.5 2024