<table border="1" cellspacing="0" cellpadding="8">
    <tr>
        <th>Issue</th>
        <td>
            <a href=https://github.com/llvm/llvm-project/issues/68335>68335</a>
        </td>
    </tr>

    <tr>
        <th>Summary</th>
        <td>
            Provide more guidance on titles and labels when filing issues
        </td>
    </tr>

    <tr>
      <th>Labels</th>
      <td>
            new issue
      </td>
    </tr>

    <tr>
      <th>Assignees</th>
      <td>
      </td>
    </tr>

    <tr>
      <th>Reporter</th>
      <td>
          smcpeak
      </td>
    </tr>
</table>

<pre>
    The page [How to submit an LLVM bug report](https://llvm.org/docs/HowToSubmitABug.html) has instructions on submitting bug reports, but it does not explain anything about conventions for titles, use of names in brackets like "[clang]", "[doc]", etc., or on usage of labels like "crash".

It also has this parenthetical remark that doesn't make sense to me:

> (note that you don't need to pick a label, just use if you're not sure)

When filing issues myself, I've tried to infer rules from the existing practice, but existing practice seems to be quite diverse, so it's hard to know what practices to follow.  It's also not clear which practices are available to those who aren't project members (those without full permissions to modify issues).

Therefore I request that the `HowToSubmitABug.html` page be enhanced to contain answers to these questions:

1. What should go into the main title text?  Is there a maximum suggested title length?  What are some examples of good issue titles?  Should Markdown backtick syntax be [used in titles](https://github.blog/changelog/2021-04-13-back-tick-code-blocks-are-now-supported-in-titles/)?

2. What bracketed prefix words should be used, if any?  What does each one mean? Is there a standard term for "bracketed prefix words"?

3. As someone filing an issue, should I be somehow adding labels?  I do not see any way to do so directly, but I noticed in one case that a bracketed prefix word seemed to automatically add a label (which was later manually removed by a maintainer, which suggests I didn't do that right).

Where relevant, the information should distinguish what project members should do from what non-members do.

I think a link to https://github.com/llvm/llvm-project/labels would be helpful somewhere in this vicinity.  But most labels do not currently have descriptions, which limits its utility somewhat.

Finally, I suggest linking to this material directly from the "Helpful resources" sidebar of the issue filing interface.  Currently it takes three clicks to reach it: "Contributing" -> "Contributing to LLVM" -> (scroll down) "How to submit an LLVM bug report".

</pre>
<img width="1px" height="1px" alt="" src="http://email.email.llvm.org/o/eJyUVk1v4zgS_TX0pWDDpmI7PviQdK_RAWaABaaxfabIksQxRXpYpBX_-0WRVj5mAiz2kCiRivXxqt4rKiLbe8Sj2D6L7feFymkI8UijvqA6L9pgbsefA8JF9Qhi-_wjTJACUG5Hm0B5-O23__wObe4h4iXEJLbfhXwcUrqQaJ6EPAl5cu46rkLshTyZoEnI048w_Qx_FB9Pz7lfDWl0Qh5gUATWU4pZJxs8QfD3UMn6_kMYEvIbtDmBTWACEviQAF8vTlkPyt_SwPaqDTmBDv6KvvrrQoRkk8PiIBNC6MCrETkutFHpMyYCZ88IQkqxfdZO-b5UJflIfWmCfn-FSa_4GSKnm4mRCh041aJ7d6WjokFIuRLr72L9VH-_JFCOQqk7DZbgoiL6NGCyWjmIOKp4hjSoWqUXcp9gVGcEQk_InRiRcf7gUzT_AiEffUhYT95CBhPqWY9o-NTF6jOomiPn_memVOCwHdsLuY9YMKUcUcjDxwC_BvTQWccIW6KMBOON0HXs6EXI_RUhRVsDWd9hhJgdEnQxjJAGBHy1VBp6iUonq3Hu5j8-ACGOxI5ahL-yTQjGXjFSOUIBbBJyTzCoWMKdfZhg4qpnD-VwF5wL0wrgpZoX0Lk87VBFmAarhw8nVERQV2Wdal0BOQ2BEKYh8KeK5CWGP1EnGHFsMRJDfreyaeCx67JzcME4WqIye9ysYGx3u6Mm5OHTMPwcMGIXIsILRPwrI6XaQIZM7NZfkma3rtRsEdAPyusKuw4-VSrQxNmVGpAYQ6RChb9NzWYFvzgWDSE7Az13rh6CkR0V0kDC1ySaE8ALzysyTDCqVzvmESj3PVLi-MXWoe_TUKyLZwaVwsjdV-OF5yF00IdgKhwzLdn-j5rE7yqeTZg8tEqfE08s3XxSr1ys2D5nQgNzavSV8PQ2DbldtS6w9uhB-R7r33ItN8v1w3LTLNn5kr0vdTC4bF3QZ1qqiEsfpiXlC-sNmqX1y1k5TsyI5vQRP3nH7y4haOASsbOvMIVoaIa1RSaZ4dm1HevUOzxFxVDpAYJHGFF5_vYBZ0rKmzLmGMciZELKr8OxMH1Or1nBExX42fudvMpX6AuVaoIvnCKbDWECZQybVSGrbQdTeUOInD5M6sazZQJz0diIOrnbzOYXNrW6donjakV3TVJfA1XoXidY5RRGVXTQ3TiVWa6YaZWwkyJwKmGEUflc7CKO4YoG2luZTFtYgJEzqmfuU0pcijWVyibUpKLth_R3Vv4q8Ed0eFU-sSPmhPVdiJweL6gKnanSlS0NswJ9VojZLlQhLDY--OX83YTPu4E3gi8qzY8U4Mvh1mG8r9j7Y3mPy__WFTTNszegu3TZlQZPpS6mD--dq9XW23RbATznBGOgNC-we8d1jrya3A0GdUUwSDraS5WSN3SdHW0i4J-crLPpdo-l0qfaTtZzu8rCmFtSyuR5K7JjCUZurVXuba7eF4iQ8se9logUctRMSwlkDbYqsrKULhVhmVeVTxg7pXEF8O2tGJsgqTNviSEignZWn4tcxsJFm0TzxOG-BZ-ibTO3mCMt65r99J6P8XXow_dH0jE4ByxjfMHhxP_XDertjrAwx8YcmoNa4HGzO-y2crdp9ovhuG32-4cDYmPU7nG9we3ugLhVh_YgH3fbZrewR7mWzWa93m72m22zW232O6PWu8eHbqMU6p14WOOorFvNd7NFweq4e2ya7aJ2vlwJpfQ4zTIh-YYYj2XK2tyTeFg7S4nevRSFPP47hqs1CCMvsz5bw3uJL0dVQEF5M0_X9I_LxCJHd_y_R31eqadSwX8DAAD__4P2sCo">