Skip to content

Updated issue templates(formatting and rustbot label reference) #7600

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 27, 2021

Conversation

xFrednet
Copy link
Member

This PR updates our issue templates. The changes are:

  1. Make the Meta section smaller and not indented

    The current format sometimes gets messed up when a user simply pasts the rustc version into the issue without indenting it to match the code block. Removing the indention should hopefully help with formatting in the future.

    Example of messed up formatting

    image

    Additionally, I've removed the Version of Clippy from the template. Every issue that I have seen had matching rustc and Clippy versions, and just asking for rustc -Vv makes the issue look cleaner IMO.

  2. Add a comment explaining how additional labels can be added with @rustbot label +<label>. The explanation looks like this:

    <!--
    Additional labels can be added to this issue by including the following command:
    
    @rustbot label +<label>
    
    Common labels for this issue type are:
    * `I-suggestion-causes-error`
    -->
    

    The example @rustbot call can sadly not be marked as code inside a comment block. But the example will not cause the bot to add any labels. See Test issue (Testing the label command from rustbot) #7599


changelog: none

cc: @rust-lang/clippy

@rust-highfive
Copy link

r? @camsteffen

(rust-highfive has picked a reviewer for you, use r? to override)

@rust-highfive rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties label Aug 25, 2021
@camsteffen
Copy link
Contributor

Thanks! @bors r+

@bors
Copy link
Contributor

bors commented Aug 27, 2021

📌 Commit 10909ae has been approved by camsteffen

@bors
Copy link
Contributor

bors commented Aug 27, 2021

⌛ Testing commit 10909ae with merge 5e1e9b0...

@bors
Copy link
Contributor

bors commented Aug 27, 2021

☀️ Test successful - checks-action_dev_test, checks-action_remark_test, checks-action_test
Approved by: camsteffen
Pushing 5e1e9b0 to master...

@bors bors merged commit 5e1e9b0 into rust-lang:master Aug 27, 2021
@xFrednet xFrednet deleted the 0000-update-issue-templates branch August 27, 2021 15:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-waiting-on-review Status: Awaiting review from the assignee but also interested parties
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants