[[preface-reporting]]
=== Reporting Problems
[role="summary"]
How to report an issue with this guide (with detailed steps).

==== Goal

Report a problem with this guide, such as:

* Information that is incorrect or does not follow best practices
* Steps that do not work
* Screenshots or text that doesn't match what you see on the screen
* Unclear writing
* Places where a table or screenshot would help clarify the text
* Failure to define terminology
* Missing knowledge prerequisites or site prerequisites for a topic
* Typographical, spelling, grammar, or formatting errors
* Broken links

// ==== Prerequisite knowledge

// ==== Site prerequisites

==== Steps

. Make a note of the topic or topics that contain the problem you have found.

. Log in to https://www.drupal.org[_Drupal.org_] (you will need to create a user
account if you do not already have one).

. Visit the https://www.drupal.org/project/issues/user_guide[User Guide issues
page on _Drupal.org_].

. Verify that the problem you found has not already been reported in another
issue:
  * If there are only a few open issues, scan the _Summary_ column to see if
  any of their descriptions match the problem you found. You may also need to
  read some of the issues to make sure, which you can do by clicking the links
  in the _Summary_ column.
  * If the open issue list is long, enter either a keyword related to the
  problem you found or the title of the topic where the problem occurs in the
  _Search for_ box, and click _Search_ to reduce the issue list. Then either
  scan the summaries or read the issues to see if they match your problem.

. If you determine that your problem has not already been reported, click
_Create a new issue_, and fill in the issue report as follows:
+
[width="100%",frame="topbot",options="header"]
|================================
| Field name | Explanation | Example value
| Title | Short summary of the problem you found | Instructions in "Adding
  a Content Type" do not work
| Category | Type of issue being reported | Bug report
| Version | Version of the guide you found the problem in | 8.x-0.x-dev
| Issue summary | Details of the problem you found | In the "Adding a Content
  Type" topic, in step 3, when I clicked _Save_, I got the following error
  message: ...
|================================

. Reread the _Title_ and _Issue summary_ you entered, and verify that the
following information is included in your report:
  * A complete description of the problem you found
  * The name of the topic or topics where you found the problem
  * The language you are reading the guide in (if not English)
  * If you read the guide on a website, a link to the page or pages
    with the problem

. Click _Save_ to create the issue.

. Check back on the issue in a few days. If one of the project maintainers has
asked for clarification, respond by adding a comment to the issue.

// ==== Expand your understanding

// ==== Related concepts

// ==== Additional resources


*Attributions*

Written by https://www.drupal.org/u/jhodgdon[Jennifer Hodgdon].
