aboutsummaryrefslogtreecommitdiff
path: root/.github
diff options
context:
space:
mode:
authorBen Hilburn <bhilburn@gmail.com>2018-07-06 17:21:34 +0300
committerGitHub <noreply@github.com>2018-07-06 17:21:34 +0300
commitfcc48e17eea6cda4bf0dc62338e2d96e2efbcebf (patch)
treecdf990244de32d2eb46688921629bbea924e353c /.github
parentc951a915797ee4e4f7232e073204c48ef76bee39 (diff)
Updating the Issue Template
Building on the issue template from @dritter.
Diffstat (limited to '.github')
-rw-r--r--.github/ISSUE_TEMPLATE.md48
1 files changed, 33 insertions, 15 deletions
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
index fc19b3cf..01fbc413 100644
--- a/.github/ISSUE_TEMPLATE.md
+++ b/.github/ISSUE_TEMPLATE.md
@@ -1,17 +1,35 @@
-Problems with powerlevel9k come with a lot of possible causes.
-The problem you have may arise from the used ZSH version to the
-configured font or even depend on the terminal emulator you are
-using.
-
-So, please help us a bit and describe your problem as detailed as
-possible. Here is a little questionnaire to help us ask the right
-questions:
- - What does `zsh --version` give you?
- - Do you use a ZSH framework?
+Thanks for opening an issue! For a project that deals with as many different things as P9k, debugging problems can be difficult. Please follow the guide, below, to create a bug report that will help us help you!
+
+### Before Opening a Bug
+P9k is lovingly maintained by volunteers, and we are happy to help you! You can help us by first making sure your issue hasn't already been solved before opening a new one. Please check the [Troubleshooting Guide](https://github.com/bhilburn/powerlevel9k/wiki/Troubleshooting) first. Many issues are actually local configuration problems, which may have previously been solved by another user - be sure to also [search the existing issues](https://github.com/bhilburn/powerlevel9k/issues?utf8=%E2%9C%93&q=is%3Aissue) before opening a new one.
+
+Once you've done these things, you can delete this section and proceed `=)`
+
+-----
+
+#### Describe Your Issue
+What is happening?
+
+Most issues are best explained with a screenshot. Please share one if you can!
+
+#### Have you tried to debug or fix it?
+
+
+Have you tinkered with your settings, and what happened when you did? Did you find a bit of code that you think might be the culprit? Let us know what you've done so far!
+
+#### Environment Information
+This information will help us understand your configuration.
+
+ - What version of ZSH are you using? You can use `zsh --version` to see this.
+ - Do you use a ZSH framework (e.g., Oh-My-ZSH, Antigen)?
+ - How did you install P9k (cloning the repo, by tarball, a package from your OS, etc.,)?
+ - What version of P9k are you using?
- Which terminal emulator do you use?
- - Which font do you use (for font related issues)?
- - Which powerlevel9k mode do you use (`echo $POWERLEVEL9K_MODE`)?
- - For font issues: Could you post the output of `debug/font-issues.zsh`?
-Please also have a look at the [troubleshooting guide](https://github.com/bhilburn/powerlevel9k/wiki/Troubleshooting)
-which solves the most common problems.
+#### Issues with Fonts & Icons
+You may delete this section if your issue is not font / icon related.
+
+ - Which font do you use?
+ - Which [font configuration mode](https://github.com/bhilburn/powerlevel9k/wiki/About-Fonts) are you using? You can check this with (`echo $POWERLEVEL9K_MODE`).
+ - Please share the contents of `$P9k/debug/font-issues.zsh`.
+ - If this is an icon problem, does the output of `$ get_icon_names` look correct?