Clearly signal purpose of the yaml template

[rust.git] / .github / ISSUE_TEMPLATE / bug_report.md

diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
index 5566b3d1f8d0f9d1b063a3f4f10cb5218a667fe2..5675579bc964a6aab3827db3b3c519c731f98143 100644 (file)
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -1,26 +1,44 @@
 ---
-name: Bug report
-about: Create a bug report for rust-analyzer.
-title: ''
-labels: ''
-assignees: ''
-
+name: Bug Report
+about: Create a bug report for Rust.
+labels: C-bug
 ---
-
 <!--
-Troubleshooting guide: https://rust-analyzer.github.io/manual.html#troubleshooting
-Forum for questions: https://users.rust-lang.org/c/ide/14
+Thank you for filing a bug report! 🐛 Please provide a short summary of the bug,
+along with any information you feel relevant to replicating the bug.
+-->
+
+I tried this code:
+
+```rust
+<code>
+```
 
-Before submitting, please make sure that you're not running into one of these known issues:
+I expected to see this happen: *explanation*
 
- 1. extension doesn't load in VSCodium: #11080
- 2. on-the-fly diagnostics are mostly unimplemented (`cargo check` diagnostics will be shown when saving a file): #3107
+Instead, this happened: *explanation*
 
-Otherwise please try to provide information which will help us to fix the issue faster. Minimal reproducible examples with few dependencies are especially lovely <3.
+### Meta
+<!--
+If you're using the stable version of the compiler, you should also check if the
+bug also exists in the beta or nightly versions.
 -->
 
-**rust-analyzer version**: (eg. output of "rust-analyzer: Show RA Version" command, accessible in VSCode via <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>P</kbd>)
+`rustc --version --verbose`:
+```
+<version>
+```
+
+<!--
+Include a backtrace in the code block by setting `RUST_BACKTRACE=1` in your
+environment. E.g. `RUST_BACKTRACE=1 cargo build`.
+-->
+<details><summary>Backtrace</summary>
+<p>
 
-**rustc version**: (eg. output of `rustc -V`)
+```
+<backtrace>
+```
 
-**relevant settings**: (eg. client settings, or environment variables like `CARGO`, `RUSTUP_HOME` or `CARGO_HOME`)
+</p>
+</details>