docs: Update bug report template

piksel · Dec 16, 2019 · 2edccd8 · 2edccd8
1 parent 7c05412
commit 2edccd8
Show file tree

Hide file tree

Showing 2 changed files with 32 additions and 24 deletions.
diff --git a/.github/ISSUE_TEMPLATE/Bug_report.md b/.github/ISSUE_TEMPLATE/Bug_report.md
@@ -7,8 +7,18 @@ assignees: ''
 
 ---
 
+<!--
+─────────────────────────────────────────────
+                                ⚠️ IMPORTANT: Please run the following command to create an issue:
+                                                                         
+                                                                            starship bug-report
+
+                                      An issue will be pre-populated with your system's configuration, 
+                                                          making the process a whole lot quicker 😊
+─────────────────────────────────────────────
+-->
+
 ## Bug Report
-<!-- We recommend running `starship bug-report` in the shell you are experiencing unexpected behavior. The command will automatically pre-fill a report with your system information. -->
 
 #### Current Behavior
 <!-- A clear and concise description of the behavior. -->
@@ -19,13 +29,16 @@ assignees: ''
 #### Additional context/Screenshots
 <!-- Add any other context about the problem here. If applicable, add screenshots to help explain. -->
 
+#### Possible Solution
+<!--- Only if you have suggestions on a fix for the bug -->
+
 #### Environment
 - Starship version: [the output of `starship --version`]
 - Shell type: [fish, zsh]
 - Shell version: [the output of `fish --version` or `zsh --version`]
 - Shell plugin manager: [e.g. oh-my-fish, oh-my-zsh, fisher, antigen]
 - Terminal emulator: [e.g. iTerm, Hyper, Terminator]
-- Operating system: [e.g. OSX 10.13.4, Windows 10]
+- Operating system: [e.g. macOS 10.13.4, Windows 10]
 
 #### Relevant Shell Configuration
 <!-- 
@@ -39,11 +52,8 @@ assignees: ''
 ```
 
 #### Starship Configuration
-<!-- Can be found in $XDG_CONFIG_HOME/starship.toml or  ~/.config/starship.toml -->
+<!-- Can be found in  ~/.config/starship.toml -->
 
 ```bash
 # Your configuration here
 ```
-
-#### Possible Solution
-<!--- Only if you have suggestions on a fix for the bug -->
diff --git a/src/bug_report.rs b/src/bug_report.rs
@@ -47,14 +47,12 @@ struct Environment {
 }
 
 fn make_github_issue_link(starship_version: &str, environment: Environment) -> String {
-    let title = urlencoding::encode("Bug Report:");
+    let template_filename = urlencoding::encode("Bug_report.md");
 
     let body = urlencoding::encode(&format!("<!--
 ─────────────────────────────────────────────
-
-                                This issue has been pre-populated with your system's configuration                                 
-                                                      ♥ Thank you for submitting a bug report ♥                                                     
- 
+                                This issue has been pre-populated with your system's configuration
+                                                      ♥ Thank you for submitting a bug report ♥
 ─────────────────────────────────────────────
 -->
     
@@ -69,6 +67,9 @@ fn make_github_issue_link(starship_version: &str, environment: Environment) -> S
 #### Additional context/Screenshots
 <!-- Add any other context about the problem here. If applicable, add screenshots to help explain. -->
 
+#### Possible Solution
+<!--- Only if you have suggestions on a fix for the bug -->
+
 #### Environment
 - Starship version: {starship_version}
 - {shell_name} version: {shell_version}
@@ -84,22 +85,19 @@ fn make_github_issue_link(starship_version: &str, environment: Environment) -> S
 
 ```toml
 {starship_config}
-```
-
-#### Possible Solution
-<!--- Only if you have suggestions on a fix for the bug -->",
-                                            starship_version = starship_version,
-                                            shell_name = environment.shell_info.name,
-                                            shell_version = environment.shell_info.version,
-                                            os_name = environment.os_type,
-                                            os_version = environment.os_version,
-                                            shell_config = environment.shell_info.config,
-                                            starship_config = environment.starship_config,
+```",
+        starship_version = starship_version,
+        shell_name = environment.shell_info.name,
+        shell_version = environment.shell_info.version,
+        os_name = environment.os_type,
+        os_version = environment.os_version,
+        shell_config = environment.shell_info.config,
+        starship_config = environment.starship_config,
     ));
 
     format!(
-        "https://github.com/starship/starship/issues/new?title={}&body={}",
-        title, body
+        "https://github.com/starship/starship/issues/new?template={}&body={}",
+        template_filename, body
     )
 }