-
Notifications
You must be signed in to change notification settings - Fork 12.8k
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
Add GitHub issue templates #68413
Conversation
(rust_highfive has picked a reviewer for you, use r? to override) |
What about using |
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). |
@hellow554 That's already done and part of GitHub's templates as you can see here. So they'll automatically have |
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. |
@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. |
We do have documentation for tracking issues: https://forge.rust-lang.org/lang/rfc-merge-procedure.html#step-1-open-tracking-issue. |
@Mark-Simulacrum Ah, nice. I've now included that in the template. |
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. |
@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. |
@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. |
@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 :). |
@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.
|
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. |
@spastorino I'd have no problem with another template for regressions, and linking that. |
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? |
@bors r+ rollup |
📌 Commit 49d78fc has been approved by |
@Mark-Simulacrum Since two weeks from now there is a release team meeting, can we add it to the agenda for that meeting? |
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">
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">
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
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
.