Create text template for bug creation comments
ClosedPublic

Authored by acrouthamel on Sep 21 2018, 4:17 AM.

Details

Summary

This creates a text template for the comment field when entering a
bug. I believe this is the best choice to enhance our bug creation process,
while keeping the code simple. I've been informed of the upcoming "Bugzilla
Harmony" effort at Mozilla to upstream their fork, so it may be a waste of
time to build a custom create-guided.html.tmpl before that is released.

The text will output as the following:

SUMMARY


STEPS TO REPRODUCE
1. 
2. 
3. 

EXPECTED RESULT


ACTUAL RESULT


SOFTWARE VERSIONS
(available in About System)
KDE Plasma Version: 
KDE Frameworks Version: 
Qt Version: 

ADDITIONAL INFORMATION

BUG: 383169

Diff Detail

Repository
R895 Customised Bugzilla for bugs.kde.org
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.
acrouthamel requested review of this revision.Sep 21 2018, 4:17 AM
acrouthamel created this revision.
acrouthamel edited the summary of this revision. (Show Details)Sep 21 2018, 4:19 AM
acrouthamel added a reviewer: Sysadmin.
acrouthamel added a project: Bugsquad.
acrouthamel added a subscriber: ngraham.

Awesome, I'm impressed that you found this! What do you think about adding a link to https://community.kde.org/Get_Involved/Bug_Reporting into the template somewhere? Or should that be done somewhere in the main UI elsewhere?

It's a minor thing, but the .arcconfig file should probably be done in a separate commit/patch since it's not related to the template changes.

acrouthamel added a comment.EditedSep 21 2018, 4:30 AM

I thought you'd like this. You can thank the LibreOffice team for pointing me to the repo for their create-guided.html.tmpl file. (I had noticed their "1. 2. 3." they placed into the one field).

I like the idea of adding a link to the wiki. It's easy to edit the line at the top that currently says:

Before reporting a bug, please read the bug writing guidelines, please look at the list of most frequently reported bugs, and please search for the bug.

That's a different file though. ;)

Regarding .arcconfig, it's a one-liner, so figured it wouldn't be a big deal here. But if it is an issue I can pull that.

  • Spacing update to help keep content separate
  • One more spacing fix to allow people to use next empty line
acrouthamel edited the summary of this revision. (Show Details)Sep 21 2018, 4:43 AM

Yeah if you don't mind, let's do the arcconfig file in another patch. It's good practice to keep commits atomic. :)

  • Remove gitconfig
acrouthamel retitled this revision from Added arcconfig file and created text template for bug creation comments to Create text template for bug creation comments.Sep 21 2018, 4:51 AM
acrouthamel edited the summary of this revision. (Show Details)

Yeah if you don't mind, let's do the arcconfig file in another patch. It's good practice to keep commits atomic. :)

All fixed.

bcooksley added inline comments.
template/en/default/bug/create/create.html.tmpl
484

This text should be entered above on line 476, rather than overriding the block used there.

Otherwise cloning a bug report will result in the line they've got there being ignored.

  • Change default text placement
acrouthamel marked an inline comment as done.Sep 21 2018, 4:31 PM

Good catch, apparently LibreOffice made a mistake! ;)

Let me know if this makes sense. Do I need to format it differently now?

Based on how the rest of the text is formatted i'd suggest removing the quotes and turning the newlines into actual newlines.

  • Change text formatting

Based on how the rest of the text is formatted i'd suggest removing the quotes and turning the newlines into actual newlines.

Ok, fixed. :)

bcooksley accepted this revision.Sep 21 2018, 8:40 PM

Perfect. I'll land this shortly, then deploy all three changes to the server.

This revision is now accepted and ready to land.Sep 21 2018, 8:40 PM
This revision was automatically updated to reflect the committed changes.