Skip to content
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

Add GitHub issue templates #68413

Merged
merged 1 commit into from
Feb 7, 2020
Merged

Add GitHub issue templates #68413

merged 1 commit into from
Feb 7, 2020

Conversation

XAMPPRocky
Copy link
Member

This PR adds GitHub's issue templates to the repository. Adding templates for two of the most common issues we create on the repository. We could add more specific templates (e.g. ICEs) depending on the response to initial templates. I've included a screenshot of what it looks like, and people can also try out the UI and specific templates, by going to XAMPPRocky/rust.

Screenshot 2020-01-21 at 13 57 46

@rust-highfive
Copy link
Collaborator

r? @alexcrichton

(rust_highfive has picked a reviewer for you, use r? to override)

@XAMPPRocky XAMPPRocky added the C-enhancement Category: An issue proposing an enhancement or a PR with one. label Jan 21, 2020
@rust-highfive rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Jan 21, 2020
@XAMPPRocky
Copy link
Member Author

r? @Mark-Simulacrum

@Mark-Simulacrum Mark-Simulacrum added I-nominated T-compiler Relevant to the compiler team, which will review and decide on the PR/issue. T-cargo Relevant to the cargo team, which will review and decide on the PR/issue. labels Jan 21, 2020
@hellow554
Copy link
Contributor

What about using @rustbot to modify the labels, e.g. a tracking issue should have the tracking-issue label

@Mark-Simulacrum
Copy link
Member

As the primary "source" / "destination" of issues, nominating for compiler team. I am primarily interested in anyone who is strongly opposed to this change -- if there's anyone with opposition, we should make sure to meet their needs before merging.

I would also like feedback from the Cargo team, so nominating there as well -- I believe Cargo uses templates on the rust-lang/cargo repository, and am interested in knowing how that has gone for you.


I myself am not entirely sure that this is going to be a net win for us, but could see that being the case. I think landing makes sense, in an experimental sense (we can remove if they don't seem to help).

@XAMPPRocky
Copy link
Member Author

@hellow554 That's already done and part of GitHub's templates as you can see here. So they'll automatically have C-tracking-issue or C-bug. https://github.com/rust-lang/rust/pull/68413/files#diff-b146d1c543dd5f77a89bd8026dd56b10

@steveklabnik
Copy link
Member

I like this idea! I think an ICE one would be great. Tracking issue feels kinda weird to me, given that only certain people open them at certain times, but I'm not horribly opposed.

@XAMPPRocky
Copy link
Member Author

@steveklabnik The fact that only certain people open them is actually part of the motivation for this template. Right now we don't actually have documentation on how to make a tracking issue, and as such they only specific people create them.

Anyone on a team should be able to create a tracking issue, there's no reason it should be blocked on a lead/shepherd doing the work. This template should hopefully act as both documentation on how to create a tracking issue as well as making the work more easily delegate-able to other members on team.

@Mark-Simulacrum
Copy link
Member

We do have documentation for tracking issues: https://forge.rust-lang.org/lang/rfc-merge-procedure.html#step-1-open-tracking-issue.

@XAMPPRocky
Copy link
Member Author

@Mark-Simulacrum Ah, nice. I've now included that in the template.

@ehuss
Copy link
Contributor

ehuss commented Jan 21, 2020

Seems like a good idea to me. I think templates have improved the quality of reports on the Cargo repo. I think it is important that the templates be concise (nobody likes to fill out a long form), and this seems to hit a good balance.

@Centril Centril added the T-release Relevant to the release subteam, which will review and decide on the PR/issue. label Jan 21, 2020
.github/ISSUE_TEMPLATE/bug_report.md Show resolved Hide resolved
.github/ISSUE_TEMPLATE/bug_report.md Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/tracking_issue.md Show resolved Hide resolved
.github/ISSUE_TEMPLATE/tracking_issue.md Show resolved Hide resolved
.github/ISSUE_TEMPLATE/tracking_issue.md Show resolved Hide resolved
@spastorino
Copy link
Member

@XAMPPRocky I like this idea, I wonder if we can make https://github.com/rust-lang/cargo-bisect-rustc adhere better to this or we can use here and there the same format.

@XAMPPRocky
Copy link
Member Author

XAMPPRocky commented Jan 23, 2020

@spastorino I believe we can share with all repositories by having them in https://github.com/rust-lang/.github, but I don't know if there's an easy way to share between individual repositories. Of course we can also just copy it.

@spastorino
Copy link
Member

@XAMPPRocky I was referring more to the output of the tool, that emits a report to be pasted on Github. Check this rust-lang/cargo-bisect-rustc#41 out. You can check how the report looks here spastorino/cargo-bisect-sample#1. I'm wondering if we can connect in some way that report with this templates but as the very minimum we should use the same format. Probably yours is better :).

@XAMPPRocky
Copy link
Member Author

@spastorino Ah okay, we could have something like the following, where the link leads you to the template and you paste in the info generated by the tool.

==================================================================================
= Please open an issue on Rust's github repository                               =
= https://github.com/rust-lang/rust/issues/new?labels=C-bug%2C+I-ICE%2C+T-compiler&template=ice.md
= Below you will find a text that would serve as a starting point of your report =
==================================================================================

# Regression found in the compiler

searched nightlies: from nightly-2019-09-29 to nightly-2019-09-30
regressed nightly: nightly-2019-09-30
searched commits: from https://github.com/rust-lang/rust/commit/488381ce9ef0ceabe83b73127c659e5d38137df0 to https://github.com/rust-lang/rust/commit/8431f261dd160021b6af85916f161a13dd101ca0
regressed commit: https://github.com/rust-lang/rust/commit/0bbab7d99dde8620604fb265706dc8bff20345a7
source code: URL OF A REPOSITORY THAT REPRODUCES THE ERROR

@spastorino
Copy link
Member

Yeah it could be but it would need a special template because regressions are not necessarily ICEs. Maybe we can just have a regression template and do what you're saying from the tool.

@XAMPPRocky
Copy link
Member Author

@spastorino I'd have no problem with another template for regressions, and linking that.

@Mark-Simulacrum
Copy link
Member

Okay, let's merge this in, and we can iterate (or back this out) depending on what folks think. @XAMPPRocky Can we try to post something on users or internals in 2 weeks or so to ask for feedback on the templates?

@Mark-Simulacrum
Copy link
Member

@bors r+ rollup

@bors
Copy link
Contributor

bors commented Feb 6, 2020

📌 Commit 49d78fc has been approved by Mark-Simulacrum

@bors bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Feb 6, 2020
@XAMPPRocky
Copy link
Member Author

@Mark-Simulacrum Since two weeks from now there is a release team meeting, can we add it to the agenda for that meeting?

Dylan-DPC-zz pushed a commit to Dylan-DPC-zz/rust that referenced this pull request Feb 7, 2020
Add GitHub issue templates

This PR adds GitHub's issue templates to the repository. Adding templates for two of the most common issues we create on the repository. We could add more specific templates (e.g. ICEs) depending on the response to initial templates. I've included a screenshot of what it looks like, and people can also try out the UI and specific templates, by going to [`XAMPPRocky/rust`](https://github.com/XAMPPRocky/rust/issues/new/choose).

<img width="1115" alt="Screenshot 2020-01-21 at 13 57 46" src="https://user-images.githubusercontent.com/4464295/72807027-c51baa00-3c56-11ea-8a4c-98238489b345.png">
Dylan-DPC-zz pushed a commit to Dylan-DPC-zz/rust that referenced this pull request Feb 7, 2020
Add GitHub issue templates

This PR adds GitHub's issue templates to the repository. Adding templates for two of the most common issues we create on the repository. We could add more specific templates (e.g. ICEs) depending on the response to initial templates. I've included a screenshot of what it looks like, and people can also try out the UI and specific templates, by going to [`XAMPPRocky/rust`](https://github.com/XAMPPRocky/rust/issues/new/choose).

<img width="1115" alt="Screenshot 2020-01-21 at 13 57 46" src="https://user-images.githubusercontent.com/4464295/72807027-c51baa00-3c56-11ea-8a4c-98238489b345.png">
bors added a commit that referenced this pull request Feb 7, 2020
Rollup of 7 pull requests

Successful merges:

 - #68164 (Selectively disable sanitizer instrumentation)
 - #68413 (Add GitHub issue templates)
 - #68889 (Move the `hir().krate()` method to a query and remove the `Krate` dep node)
 - #68909 (Respect --nocapture in panic=abort test mode)
 - #68910 (Add myself to .mailmap)
 - #68919 (Remove HashStable impl for ast::Lifetime)
 - #68928 (clean up E0276 explanation)

Failed merges:

r? @ghost
@bors bors merged commit 49d78fc into rust-lang:master Feb 7, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-enhancement Category: An issue proposing an enhancement or a PR with one. S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. T-cargo Relevant to the cargo team, which will review and decide on the PR/issue. T-compiler Relevant to the compiler team, which will review and decide on the PR/issue. T-release Relevant to the release subteam, which will review and decide on the PR/issue.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet