Last updated May 17, 2013.

On this page:

To get help completing this task, see the Getting help completing your task page.

Goal

Take an existing issue that has been reported on Drupal Core, a contributed module, or contributed theme, and document the steps to reproduce the issue ("STR").

Skills needed

Some familiarity with the contributed module or theme the issue was reported on. Ability to read and write understandably in English.

Detailed steps

  1. If you don't have a Drupal site to test on, set up a local server. You probably do not want to use a live, production web site for this task.
  2. Find issues for a project.
  3. First, try using the advanced search for issues in that queue with Needs steps to reproduce as an issue tag. If there are none in that project, find an open issue that is of category "bug report", status "active", "needs work", or "needs review", and in the Drupal version you are using (Drupal 7.x, 6.x, etc.).
  4. Check whether there are already clear, detailed steps to reproduce listed in the issue summary. If there are, choose a different issue.
  5. Read the issue and look for an explanation of what the bug is and how to reproduce it.
  6. If you have not already, install the module or theme on your test site.
    • If possible, use the project's most recent -dev build (or HEAD in a git repository).
    • If it is an issue with Drupal core, it's recommended to start from a fresh installation (i.e., your first step is something like "Install the latest Drupal 8.x using the standard profile"). If possible, first try to confirm if the issue exists in the 8.x branch. (See the instructions for downloading Drupal 8 with git.)
  7. Your goal now is to reproduce the issue on your test site and document the steps exactly.
  8. Post the exact steps that you took in your attempt to reproduce the issue in a comment on the issue. Use a numbered list (<ol> tag) and short, precise instructions.

    Example steps to reproduce for a Drupal core issue

    1. Install the latest Drupal 7.x using the standard profile.
    2. Create a custom menu called Custom at admin/structure/menu/add.
    3. Create two page nodes, Foo and Bar.
    4. Go to admin/structure/menu/manage/menu-custom/add and add the nodes to the custom menu with Bar as a child of Foo.
    5. Go to admin/structure/block and put the menu block for the custom menu in a sidebar.
    6. Click on Foo. The menu item for Bar is not displayed.
    7. Visit Bar. The menu item for Foo is not active or expanded.
  9. If the steps do not reproduce the issue, indicate that in your comment.
  10. Remove the "Needs steps to reproduce" tag (see screenshot below) and save your comment.

Issue form with steps to reproduce tag removed

Background and reference information

  • In the steps above, to remove an issue tag, scroll to the bottom of the issue. You will see a Comment form. Just above the comment form, you have the ability to change the issue title, status, category, etc. Below the comment form, you have the ability to change the Tags (you will need to click the Tags link to show this field).
  • Explanation of issue status settings
  • Guidelines for issue tags

Next steps: moving beyond this task

  • If the issue has few replies (and was posted by someone other than a maintainer or contributor for that project), you can then follow the steps for verifying a reported issue.
  • If the issue is an issue for Drupal core and you were able to reproduce the issue, you can also add or update the issue summary with those steps to reproduce.
  • If you are a programmer and the project has an automated test suite, contribute an automated test based on an issue's documented steps to reproduce.
AttachmentSize
adding_str.png76.83 KB