diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index bd1a032ed..000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: '[BUG] ' -labels: bug -assignees: '' - ---- - -Be sure to read the [FAQ](https://github.com/fastfetch-cli/fastfetch?tab=readme-ov-file#faq) before submitting a new issue. - - - -# General description of bug: - -* What happened: -* What should happen: -* Fastfetch version used: -* Did it work in an older version: -* Where did you get the binary: -* Does this issue still occur in [the latest dev build](https://github.com/fastfetch-cli/fastfetch/actions/)? - -# Often helpful information: - -Screenshot: - - -The content of the configuration file you use (if any): -``` -// Paste here -``` - -Output of `fastfetch -c ci.jsonc --format json`: - - -``` -// Paste here -``` - -Output of `fastfetch --list-features`: -``` -// Paste here -``` - -## If fastfatch crashed or froze - -Paste the stacktrace here. You may get it with: - -```shell -# You may need Ctrl+C to stop the process if it freezes -gdb -q -ex 'set confirm off' -ex run -ex 'bt full' -ex quit --args /path/to/fastfetch -``` - -If you are able to identify which module crashed, the strace can be helpful too - -```shell -strace /path/to/fastfetch --multithreading false -s {MODULE} --pipe -``` - -If you cannot do the instructions above, please upload the core dump file: - -## If fastfetch is slow - -Use `time fastfetch --stat` to show time usage for each module. - -## If an image or logo didn't show - - - -* The image protocol you used: -* The terminal you used: -* Upload the image file here, or paste the image URL: -* Does it work with `--logo-width {WIDTH} --logo-height {HEIGHT}`? - -## If fastfetch behaves incorrectly on shell startup - -* The bug is reproducible with a clean shell configuration (i.e. `fastfetch` is the only line in `.zshrc` or `~/.config/fish/config.fish`): -* Does `sleep 1` before running `fastfetch` work? diff --git a/.github/ISSUE_TEMPLATE/bug_report_crash.yml b/.github/ISSUE_TEMPLATE/bug_report_crash.yml new file mode 100644 index 000000000..8a77dd697 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report_crash.yml @@ -0,0 +1,117 @@ +name: Crash Bug Report +description: If fastfetch crashes or freezes +title: "[BUG] " +labels: ["bug", "crash", "triage"] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! We will try hard to solve the issue. + However since platforms and hardwares vary greatly, it can be hard to find the root cause of an issue. + Providing the following information may help us greatly. Thanks in advance! + - type: checkboxes + attributes: + label: Read the FAQ first + description: Please check if the issue is already covered in the FAQ. + options: + - label: I have checked the FAQ but the issue is not covered + required: true + - type: markdown + attributes: + value: "### General description of the bug" + - type: textarea + attributes: + label: Description + description: A clear and concise description of what the bug is. + placeholder: I was trying to [...] but [...] + validations: + required: true + - type: input + attributes: + label: Version used + description: Fastfetch version used. Please use the latest version (found in the [releases](https://github.com/fastfetch-cli/fastfetch/releases)) if possible. + placeholder: Result of `fastfetch --version` + validations: + required: true + - type: dropdown + attributes: + label: Bug prevalence + description: How often does the bug occur? + options: + - + - Always + - Sometimes + - Rarely + - Once + - Other + validations: + required: true + - type: dropdown + attributes: + label: Regression + description: Did it work in an older version? + options: + - + - Not sure + - 'Yes' + - 'No' + validations: + required: true + - type: dropdown + attributes: + label: Installation + description: Where did you install fastfetch from? + options: + - + - GitHub Releases + - GitHub Actions (nightly) + - Built from source + - Package manager + validations: + required: true + - type: input + attributes: + label: Package manager + description: Which package manager did you use if applicable? + placeholder: e.g. `apt`, `pacman`, `brew`, `scoop` + - type: markdown + attributes: + value: '### Often helpful information' + - type: textarea + attributes: + label: Screenshots + description: If applicable, add screenshots to help explain your problem. + - type: textarea + attributes: + label: Configuration + description: If applicable, paste your configuration file here. + - type: textarea + attributes: + label: System information + description: Output of `fastfetch -c all.jsonc --stat --format json` + placeholder: | + Note that this output will contain you public IP. + If it is not relevant for the issue, feel free to remove it before uploading. + - type: markdown + attributes: + value: | + Paste the stacktrace here. You may get it with: + + ```shell + # You may need Ctrl+C to stop the process if it freezes + gdb -q -ex 'set confirm off' -ex run -ex 'bt full' -ex quit --args /path/to/fastfetch + ``` + + If you are able to identify which module crashed, the strace can be helpful too + + ```shell + strace /path/to/fastfetch --multithreading false -s {MODULE} --pipe + ``` + + If you cannot do the instructions above, please upload the core dump file if available. + - type: textarea + attributes: + label: Stacktrace + description: Paste the stacktrace or core dump file here. + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/bug_report_general.yml b/.github/ISSUE_TEMPLATE/bug_report_general.yml new file mode 100644 index 000000000..2d6f1c8ed --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report_general.yml @@ -0,0 +1,96 @@ +name: General Bug Report +description: If something is not working as expected (wrong output, missing info, etc) +title: "[BUG] " +labels: ["bug", "triage"] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! We will try hard to solve the issue. + However since platforms and hardwares vary greatly, it can be hard to find the root cause of an issue. + Providing the following information may help us greatly. Thanks in advance! + - type: checkboxes + attributes: + label: Read the FAQ first + description: Please check if the issue is already covered in the FAQ. + options: + - label: I have checked the FAQ but the issue is not covered + required: true + - type: markdown + attributes: + value: "### General description of the bug" + - type: textarea + attributes: + label: Description + description: A clear and concise description of what the bug is. + placeholder: I was trying to [...] but [...] + validations: + required: true + - type: input + attributes: + label: Version used + description: Fastfetch version used. Please use the latest version (found in the [releases](https://github.com/fastfetch-cli/fastfetch/releases)) if possible. + placeholder: Result of `fastfetch --version` + validations: + required: true + - type: dropdown + attributes: + label: Bug prevalence + description: How often does the bug occur? + options: + - + - Always + - Sometimes + - Rarely + - Once + - Other + validations: + required: true + - type: dropdown + attributes: + label: Regression + description: Did it work in an older version? + options: + - + - Not sure + - 'Yes' + - 'No' + validations: + required: true + - type: dropdown + attributes: + label: Installation + description: Where did you install fastfetch from? + options: + - + - GitHub Releases + - GitHub Actions (nightly) + - Built from source + - Package manager + validations: + required: true + - type: input + attributes: + label: Package manager + description: Which package manager did you use if applicable? + placeholder: e.g. `apt`, `pacman`, `brew`, `scoop` + - type: markdown + attributes: + value: '### Often helpful information' + - type: textarea + attributes: + label: Screenshots + description: If applicable, add screenshots to help explain your problem. + - type: textarea + attributes: + label: Configuration + description: If applicable, paste your configuration file here. + - type: textarea + attributes: + label: System information + description: Output of `fastfetch -c all.jsonc --stat --format json` + placeholder: | + Note that this output will contain you public IP. + If it is not relevant for the issue, feel free to remove it before uploading. + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/bug_report_logo.yml b/.github/ISSUE_TEMPLATE/bug_report_logo.yml new file mode 100644 index 000000000..9c57948e1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report_logo.yml @@ -0,0 +1,120 @@ +name: Logo Bug Report +description: If my image logo is not displayed correctly +title: "[BUG] " +labels: ["bug", "logo", "triage"] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! We will try hard to solve the issue. + However since platforms and hardwares vary greatly, it can be hard to find the root cause of an issue. + Providing the following information may help us greatly. Thanks in advance! + - type: checkboxes + attributes: + label: Read the FAQ first + description: Please check if the issue is already covered in the FAQ. + options: + - label: I have checked the FAQ but the issue is not covered + required: true + - type: markdown + attributes: + value: "### General description of the bug" + - type: textarea + attributes: + label: Description + description: A clear and concise description of what the bug is. + placeholder: I was trying to [...] but [...] + validations: + required: true + - type: input + attributes: + label: Version used + description: Fastfetch version used. Please use the latest version (found in the [releases](https://github.com/fastfetch-cli/fastfetch/releases)) if possible. + placeholder: Result of `fastfetch --version` + validations: + required: true + - type: dropdown + attributes: + label: Bug prevalence + description: How often does the bug occur? + options: + - + - Always + - Sometimes + - Rarely + - Once + - Other + validations: + required: true + - type: dropdown + attributes: + label: Regression + description: Did it work in an older version? + options: + - + - Not sure + - 'Yes' + - 'No' + validations: + required: true + - type: dropdown + attributes: + label: Installation + description: Where did you install fastfetch from? + options: + - + - GitHub Releases + - GitHub Actions (nightly) + - Built from source + - Package manager + validations: + required: true + - type: input + attributes: + label: Package manager + description: Which package manager did you use if applicable? + placeholder: e.g. `apt`, `pacman`, `brew`, `scoop` + - type: markdown + attributes: + value: '### Often helpful information' + - type: textarea + attributes: + label: Screenshots + description: If applicable, add screenshots to help explain your problem. + - type: textarea + attributes: + label: Configuration + description: If applicable, paste your configuration file here. + - type: markdown + attributes: + value: | + #### If an image or logo didn't show + + Please make sure your terminal supports the image protocol you used. + Note that GNOME Terminal doesn't support any image protocols as of now + + Some tips: + 1. Try `fastfetch --show-errors` to see if there are any errors. + 2. Try `fastfetch --logo-width {WIDTH} --logo-height {HEIGHT}`. Some protocols may require a image size being set. + - type: input + attributes: + label: Image protocol + description: The image protocol you used + validations: + required: true + - type: input + attributes: + label: Terminal + description: The terminal you used + validations: + required: true + - type: textarea + attributes: + label: Image tried + description: Upload the image file, or paste the image URL here + validations: + required: true + - type: textarea + attributes: + label: Error message + description: Error message printed by `fastfetch -s none --show-errors`, if any