Problem/Motivation

When using the dreditor "INSERT TEMPLATE" button, it inserts text with 5 sections:

  1. Problem/Motivation
  2. Proposed resolution
  3. Remaining tasks
  4. User interface changes
  5. API changes

I have found that people often forget to add the steps to reproduce the issue. Having an explicit section for this should help with this (at least for those who are using dreditor).

Steps to reproduce

  1. Install dreditor (see dreditor.org)
  2. Create a new issue
  3. Click "INSERT TEMPLATE" button
  4. You will see these sections inserted into the "Issue summary" text area

Proposed resolution

Add a new section to:

https://www.drupal.org/node/3156940

for "Steps to reproduce" so it looks like:

<h3 id="summary-problem-motivation">Problem/Motivation</h3>


<h4 id="summary-steps-reproduce">Steps to reproduce</h4>


<h3 id="summary-proposed-resolution">Proposed resolution</h3>


<h3 id="summary-remaining-tasks">Remaining tasks</h3>


<h3 id="summary-ui-changes">User interface changes</h3>


<h3 id="summary-api-changes">API changes</h3>


<h3 id="summary-original-report">Original report by <a href="#">@username</a></h3>

Note: We're also proposing to use this template as the default value on the body field for new issue nodes at #1393226: Encourage use of issue summary template

Remaining tasks

  1. Decide if we want to do this
  2. Add the text to https://drupal.org/node/3156940 (someone with full documentation editing rights needs to edit this)

User interface changes

Extra text shown in issue summary body when using dreditor's "INSERT TEMPLATE" button.

API changes

N/A

CommentFileSizeAuthor
#13 dreditor-1.2.20-plugin.zip.txt43.84 KBdww

Comments

kristen pol’s picture

kristen pol
she/her
Primary language English
Location Santa Cruz, CA, USA
commented
Issue summary: View changes
yesct’s picture

yesct commented
Related issues: +#1465924: Add explicit field/section for steps to reproduce

gathering some info.

general conversation on
#1465924: Add explicit field/section for steps to reproduce
is helpful context

--
steps to reproduce is for bugs... what about the other kinds of issues: feature request, task, support request? I'm not sure STR is useful for those categories. (similar to concern 2. in comment #14 #1465924-14: Add explicit field/section for steps to reproduce

Bojhan’s picture

Bojhan commented

Lets add it under "Problem/Motivation". Since it should be part of the problem statement. People should be smart enough to remove it when its not relevant.

avpaderno’s picture

avpaderno
he/him
Primary language Italian
Location Brescia, 🇮🇹 🇪🇺
commented
Project: Drupal.org site moderators » Documentation
Component: Textual improvements » Correction/Clarification
dww’s picture

dww
we/he/they
commented
Issue summary: View changes
Related issues: +#1393226: Encourage use of issue summary template

+100 to this!

I agree it can be an <h4> under Problem/Motivation.

Maybe it should also start with some stub <ol> markup, too?

E.g.:

<h3 id="summary-problem-motivation">Problem/Motivation</h3>


<h4 id="summary-steps-reproduce">Steps to reproduce</h4>
<ol>
  <li></li>
  <li></li>
</ol>

...

?

We're talking about using this template as the default value for the body field on issue nodes on d.o: #1393226: Encourage use of issue summary template, and including this section is one of the primary reasons we want that. So let's fix both while we're fixin'. ;)

Thanks!
-Derek

p.s. Updating the summary, since the page moved to 3156940 (breaking dreditor). :/

dww’s picture

dww
we/he/they
commented
Status: Active » Needs review

Not really sure the status values are meaningful in this queue, but just in case... ;)

dww’s picture

dww
we/he/they
commented
Title: Add "Steps to reproduce" section to "Bare issue summary template" for dreditor » Add "Steps to reproduce" section to "Bare issue summary template" for dreditor and default value for new issues
Project: Documentation » Drupal core
Version: » 9.1.x-dev
Component: Correction/Clarification » documentation
Issue summary: View changes

At @jhodgdon's suggestion in Slack, moving this to the core queue for better visibility...

I mean, as a practical matter we can edit the page any time, but we've been using that issue summary for a while as it is, and it probably merits discussion and a slight bit more visibility, by moving it to Coding Standards. Or Core.

Thanks,
-Derek

kristen pol’s picture

kristen pol
she/her
Primary language English
Location Santa Cruz, CA, USA
commented

Regarding #5, while I personally like the suggestion of adding the template ordered list markup by default, I imagine some people might think it's overkill.

dww’s picture

dww
we/he/they
commented

Re: #8, yeah, probably too much clutter and bloat. Plus, we have BUEditor to help everyone with formatting lists (not just dreditor users). So yeah, forget that proposal. ;) Glad I didn't put it into the summary.

Cheers,
-Derek

quietone’s picture

quietone commented

Nice idea, I like it.

+1

avpaderno’s picture

avpaderno
he/him
Primary language Italian
Location Brescia, 🇮🇹 🇪🇺
commented

Is Dreditor still supported? I thought it was abandoned, reading the README.md file on https://github.com/unicorn-fail/dreditor. (I am asking because the issue title says for dreditor.)

kristen pol’s picture

kristen pol
she/her
Primary language English
Location Santa Cruz, CA, USA
commented

I don't think it's been supported for awhile. I still use it but the template button hasn't been working for awhile which is sad and then I don't format my issue summaries well. :(

dww’s picture

dww
we/he/they
commented
StatusFileSize
new dreditor-1.2.20-plugin.zip.txt43.84 KB

Dreditor is not really "supported", but @briangilbert has forked a copy to keep it limping along for now.

https://addons.mozilla.org/en-GB/firefox/addon/dreditor-for-firefox

That works for FF. You can install it on Chrome, too. If you're on a Mac, once you install on FF, you can:

  1. Go into ~/Library/Application\ Support/Firefox/Profiles/default.tdm/extensions/
  2. Find the latest .xpi file you added, copy it somewhere else and rename it to dreditor.zip
  3. Unzip that.
  4. Open Chrome
  5. Visit chrome://extensions
  6. Toggle "Developer mode" in the top right corner.
  7. Click "Load unpacked" button now visible at the top left corner.
  8. Point it at the directory where you unzipped the FF extension-renamed-to-zip
  9. Rejoice

I'm attaching my copy of the dreditor.zip I used (as .txt). So you can download this, rename it from .zip.txt to .zip, and proceed from step #3.

Enjoy!
-Derek

dww’s picture

dww
we/he/they
commented
Status: Needs review » Fixed

Fait accompli - we included this in the default issue body as part of #1393226: Encourage use of issue summary template

But, to help with the folks using Dreditor updating existing issues, I just fixed these, too:

https://www.drupal.org/community/contributor-guide/reference-information...
https://www.drupal.org/community/contributor-guide/reference-information...
https://www.drupal.org/community/contributor-guide/reference-information...

(WTF with these URL aliases?) ;)

Calling this fixed and crediting everyone who participated here.

Thanks!
-Derek

kristen pol’s picture

kristen pol
she/her
Primary language English
Location Santa Cruz, CA, USA
commented

Yay! Thanks @dww!

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.