docs: add GitHub issue template #33164
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| <!--- | ||
| Hi! This template is here to help us collect optimal issue reports. Feel free to adapt it to your situation. | ||
| First, check whether the issue has already been reported. If so, please add this report to that issue thread. If not, proceed to file this new issue. | ||
| Next, please provide a one to four sentence summary of the issue. If you do your very best to be clear, concise and accurate here, other Rustaceans will be eager to assist. Also try to mention which GitHub labels this issue likely needs and/or what parts of Rust it relates to. | ||
| ---> | ||
|
|
||
| ## Code sample | ||
| <!--- | ||
| Please craft a minimal/simple and self-contained code sample that (re)produces the issue. If you create a formal test case straight away, that'll be even more helpful. | ||
|
There was a problem hiding this comment. What is a formal test case? Is it a function with a In addition to that, sometimes people can’t be bothered/don’t know how to to minimise their crate to a simple test case, so giving a link to the commit/branch/etc of a public project should also be an option. There was a problem hiding this comment. I don't know, but a section of code that runs on playpen and produces the relevant behavior is very nice. That's how I try to report bugs. There was a problem hiding this comment. I do not disagree. It is pain to minimize other people’s crates to minimal test cases too. That being said see this. |
||
| ---> | ||
| `main.rs`: | ||
| ```rust | ||
|
|
||
| ``` | ||
|
|
||
| ## Expected behavior | ||
| <!--- | ||
| Please concisely explain what you expected instead of encountering of the issue. Check if it's helpful to refer to some relevant externalities. | ||
| * Could you refer to parts of official documentation, standards, comments in this codebase, etc.? | ||
| * Did/does the issue not occur with past/other versions? | ||
| * In case it's a correctness issue, then what's the relevant behavior of other implementations (for other languages)?. | ||
| * Are there very similar (perhaps informal) issue reports outside this issue tracker? | ||
| ---> | ||
|
|
||
| ## Actual behavior | ||
| <!--- | ||
| Please paste here any human readable output in full. Important information can be in the initial details, so don't cut. | ||
| ---> | ||
|
|
||
| ## Meta | ||
| `rustc --version --verbose`: | ||
| ``` | ||
|
|
||
| ``` | ||
|
|
||
| ## Backtrace | ||
| <!--- | ||
| Finally, if you haven't shared it yet, reproduce the issue with your minimal example code and share the backtrace you obtained. | ||
|
There was a problem hiding this comment.
What’s the “it” here? This also should mention, that the section is optional and only relevant for compiler crashes. |
||
| On Windows, issue in PowerShell: | ||
| $env:RUST_BACKTRACE=1; &".\problematic_executable.exe" | ||
| On other platforms, issue in your shell: | ||
| env RUST_BACKTRACE=1 ./problematic_executable | ||
| ---> | ||
| <!--- Thanks! ---> | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I’m pretty sure people who are triaging the issues are much more suited for the task of triaging the issue compared to the average compiler user.
Most of them see compiler as a black box which gets fed source files in one end, and binaries, after some time, come out from another.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As far as summary goes, people already write a summary of sorts as the title, so, perhaps that’s good enough already?