Llewellyn/starship
1
0
Fork 0
mirror of https://github.com/Llewellynvdm/starship.git synced 2024-12-26 11:37:32 +00:00
Code Issues Releases Activity

docs: Update bug report template

Browse Source
This commit is contained in:
Matan Kushner 2019-12-15 19:27:23 -05:00
parent 7c05412f46
commit 2edccd8848
No known key found for this signature in database
GPG Key ID: 4B98C3A8949CA8A4
2 changed files with 32 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
.github/ISSUE_TEMPLATE/Bug_report.md vendored
View File

@ -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 ## 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 #### Current Behavior
<!-- A clear and concise description of the behavior. --> <!-- A clear and concise description of the behavior. -->
@ -19,13 +29,16 @@ assignees: ''
#### Additional context/Screenshots #### Additional context/Screenshots
<!-- Add any other context about the problem here. If applicable, add screenshots to help explain. --> <!-- 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 #### Environment
- Starship version: [the output of `starship --version`] - Starship version: [the output of `starship --version`]
- Shell type: [fish, zsh] - Shell type: [fish, zsh]
- Shell version: [the output of `fish --version` or `zsh --version`] - Shell version: [the output of `fish --version` or `zsh --version`]
- Shell plugin manager: [e.g. oh-my-fish, oh-my-zsh, fisher, antigen] - Shell plugin manager: [e.g. oh-my-fish, oh-my-zsh, fisher, antigen]
- Terminal emulator: [e.g. iTerm, Hyper, Terminator] - 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 #### Relevant Shell Configuration
<!-- <!--
@ -39,11 +52,8 @@ assignees: ''
``` ```
#### Starship Configuration #### Starship Configuration
<!-- Can be found in $XDG_CONFIG_HOME/starship.toml or ~/.config/starship.toml --> <!-- Can be found in ~/.config/starship.toml -->
```bash ```bash
# Your configuration here # Your configuration here
``` ```
#### Possible Solution
<!--- Only if you have suggestions on a fix for the bug -->

34
src/bug_report.rs
View File

@ -47,14 +47,12 @@ struct Environment {
} }
fn make_github_issue_link(starship_version: &str, environment: Environment) -> String { 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!("<!-- let body = urlencoding::encode(&format!("<!--
───────────────────────────────────────────── ─────────────────────────────────────────────
This issue has been pre-populated with your system's configuration
This issue has been pre-populated with your system's configuration ♥ Thank you for submitting a bug report ♥
♥ 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 #### Additional context/Screenshots
<!-- Add any other context about the problem here. If applicable, add screenshots to help explain. --> <!-- 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 #### Environment
- Starship version: {starship_version} - Starship version: {starship_version}
- {shell_name} version: {shell_version} - {shell_name} version: {shell_version}
@ -84,22 +85,19 @@ fn make_github_issue_link(starship_version: &str, environment: Environment) -> S
```toml ```toml
{starship_config} {starship_config}
``` ```",
starship_version = starship_version,
#### Possible Solution shell_name = environment.shell_info.name,
<!--- Only if you have suggestions on a fix for the bug -->", shell_version = environment.shell_info.version,
starship_version = starship_version, os_name = environment.os_type,
shell_name = environment.shell_info.name, os_version = environment.os_version,
shell_version = environment.shell_info.version, shell_config = environment.shell_info.config,
os_name = environment.os_type, starship_config = environment.starship_config,
os_version = environment.os_version,
shell_config = environment.shell_info.config,
starship_config = environment.starship_config,
)); ));
format!( format!(
"https://github.com/starship/starship/issues/new?title={}&body={}", "https://github.com/starship/starship/issues/new?template={}&body={}",
title, body template_filename, body
) )
} }