Skip to content

Instantly share code, notes, and snippets.

@mxr576
Last active October 16, 2025 22:01
Show Gist options
  • Save mxr576/4407105486e103700061ae044b172368 to your computer and use it in GitHub Desktop.
Save mxr576/4407105486e103700061ae044b172368 to your computer and use it in GitHub Desktop.
default Drupal issue summary template
<h3 id="summary-problem-motivation">Problem/Motivation</h3>
(Why the issue was filed, steps to reproduce the problem, etc.)
<h4 id="summary-steps-reproduce">Steps to reproduce</h4>
(Detailed instructions on how to reproduce the issue, including exact versions used, specific paths to visit, what actions to take, etc.)
<h3 id="summary-proposed-resolution">Proposed resolution</h3>
(Description of the proposed solution, the rationale behind it, and workarounds for people who cannot use the patch.)
<h3 id="summary-remaining-tasks">Remaining tasks</h3>
(Reviews needed, tests to be written or run, documentation to be written, etc.)
<h3 id="summary-ui-changes">User interface changes</h3>
(New or changed features/functionality in the user interface, modules added or removed, changes to URL paths, or changes to user interface text.)
<h3 id="summary-introduced-terminology">Introduced terminology</h3>
(New naming and terminology, or additional or changed meanings of existing names and terminology.)
<h3 id="summary-api-changes">API changes</h3>
(API changes/additions that would affect module, install profile, and theme developers, including before/after examples if appropriate.)
<h3 id="summary-data-model-changes">Data model changes</h3>
(Database or configuration data changes that would make stored data on an existing site incompatible with the site's updated codebase, including changes to hook_schema(), configuration schema or keys, or the expected format of stored data.)
<h3 id="summary-release-notes">Release notes snippet</h3>
(Major and critical issues should include a snippet suitable for release notes.)
<h3 id="summary-original-report">Original report by [username]</h3>
(Text of the original report, used rarely for legacy issues.)

Text filtering rules on Drupal.org

Posting code

To post pieces of code, surround them with <code>...</code> tags.
For PHP code, you can use <?php ... ?>, which will also color it based on syntax.

Paragraphs and line breaks

Lines and paragraphs are automatically recognized.
The <br /> line break, <p> paragraph, and </p> close paragraph tags are inserted automatically.
If paragraphs are not recognized, simply add a couple of blank lines.

Automatic links

Web page addresses and email addresses turn into links automatically.

Allowed HTML tags

Allowed HTML tags include:

<h2> <h3> <h4> <h5> <h6> <em> <strong> <pre> <code> <del> <img> <blockquote> <q> <cite> <sup> <sub> <s> <p> <br> <ul> <ol> <li> <dl> <dt> <dd> <a> <abbr> <b> <u> <i> <table> <tr> <td> <th> <tbody> <thead> <tfoot> <colgroup> <caption> <hr> <div> <!-- -->

This site allows HTML content. Learning all of HTML may feel intimidating, but understanding a few basic tags is easy. The following examples show how each tag works.

Tag description You type You get
Heading <h2>Subtitle</h2>

Subtitle

Emphasized <em>Emphasized</em> Emphasized
Strong <strong>Strong</strong> Strong
Preformatted <pre>Preformatted</pre>
Preformatted
Code <code>Coded</code> Coded
Deleted <del>Deleted</del> Deleted
Block quote <blockquote>Block quoted</blockquote>
Block quoted
Quoted inline <q>Quoted inline</q> Quoted inline
Cited <cite>Cited</cite> Cited
Superscript <sup>Super</sup>scripted Superscripted
Subscript <sub>Sub</sub>scripted Subscripted
Paragraph <p>Paragraph one.</p> <p>Paragraph two.</p>

Paragraph one.

Paragraph two.

Line break Text with <br />line break Text with
line break
Unordered list <ul><li>First</li><li>Second</li></ul>
  • First
  • Second
Ordered list <ol><li>First</li><li>Second</li></ol>
  1. First
  2. Second
Definition list <dl><dt>Term</dt><dd>Definition</dd></dl>
Term
Definition
Link <a href="https://www.drupal.org">Drupal.org</a> Drupal.org
Abbreviation <abbr title="Abbreviation">Abbrev.</abbr> Abbrev.
Bold <b>Bolded</b> Bolded
Underline <u>Underlined</u> Underlined
Italic <i>Italicized</i> Italicized
Table <table><tr><th>Header</th></tr><tr><td>Cell</td></tr></table>
Header
Cell

Most unusual characters can be entered directly without issues.
If you encounter problems, use HTML character entities.
For example, &amp; produces an ampersand &.

Character description You type You get
Ampersand &amp;amp; &
Greater than &amp;gt; >
Less than &amp;lt; <
Quotation mark &amp;quot; "

For a complete list of HTML entities, see W3C’s HTML entities reference.

Issue references

References to project issues in the form [ #1234 ] (or [ #1234-2 ] for comments) turn into links automatically with the issue title shown on hover.
Appending @ (for example [ #1234@ ]) also displays the assigned user.

Image policy

Only images hosted on this site may be used in <img> tags.
External images are replaced with an error icon.

Comments are disabled for this gist.