Closed (won't fix)
Project:
Documentation
Component:
Correction/Clarification
Priority:
Normal
Category:
Feature request
Assigned:
Unassigned
Reporter:
Created:
29 Mar 2012 at 10:49 UTC
Updated:
3 Apr 2012 at 16:02 UTC
I am reporting http://drupal.org/node/1155816 to moderators because:
I'd like to add a section with "Steps to reproduce" or "How to kickstart working on this issue". The term is open for discussion.
My motivation is it takes a long read to (re)start working on most issues. This should not be the case when we add some guidelines. This would benefit especially sprints I hope.
Note this maybe related to (Webmasters) #1465924: Add explicit field/section for steps to reproduce.
Text to insert:
<h3 id="summary-working-on-issue">How to start working</h3>
(provide steps to reproduce this issue like using drush to install and enable modules or summation of modules used and steps taken)
Below an small example with my intended position (immediately next to Problem/Motivation
Problem/Motivation
...
How to start working
You can work on this issue by installing the imageapi and imagefield modules and add an image to your story content type.
drush dl imageapi imagefield
drush en imagefield
Configure story by adding an image field ... etc
Problem/Motivation
...
Proposed resolution
...
Remaining tasks
...
User interface changes
...
API changes
...
Comments
Comment #1
jhodgdonTo change the issue summary template, we would need to get weigh-in from some major core/contrib contributors to see if this idea is widely liked.
My thoughts... You mention two ideas:
- Steps to reproduce
- How to get started working on the issue
Steps to reproduce is already a listed part of the "problem/motivation" section on http://drupal.org/node/1155816 -- I don't really think it needs to be added as a separate section, but I wouldn't necessarily be against separating it out.
How to get started working... I am really not understanding what this should contain, and how it's different from other sections we already have? I mean, we don't want to give instructions on each issue about how to apply a patch, install Git, set up dev environment, etc. What would really go here that wouldn't be elsewhere in the summary?
Comment #2
clemens.tolboom@jhodgdon: I should indeed have left out 'Steps to reproduce'. That is part of the Problem/Motivation section.
I do think a section to promote start working on an issue deserves on of it own as the problem gets resolved by the patches added. Steps to reproduce as not applicable for an evolving issue.
Furthermore by adding a particular section 'Start working' my hopes are they will get filled in.
The purpose it to tell people what they need to do _after_ having applied the patch which are mostly configuration or content actions.
On example is #1364798: Impossible to generate meaningful diffs of upgrade db dumps where I had no clue how to start working on the issue. So I added the section 'Preparation' which I hope helped others.
So the section term could be: 'Preparation' or 'How to start working' or ... (I'm no that good in english).
Did that makes sense?
Comment #3
jhodgdonHm. That issue is kind of out of the ordinary... and I can't really understand the Preparation section that is there. And if this "preparation" section is only needed for a few "odd" issues, I don't think we need to add it to the issue summary template. People can always add sections to issue summaries (as you did there) in the rare cases where it's a good idea.
So can you give an example from a more "normal" issue (one where there's a bug in Drupal itself, or a contrib module, and a proposed patch is made to fix the software) of what you would put in the Preparation section?
Comment #4
clemens.tolboomFollowing #1465924: Add explicit field/section for steps to reproduce #4 remark let's close this one.
I'm just getting tired reading all comments finding out the setup is too big for a friday afternoon. Or too easy for a weekend issue surfing ;)
I'll try to summarize my 'steps to reproduce' for issues I add a patch for.
@jhodgdon: Thanks for your energy.