Add Performance Issue Template

This commit is contained in:
Dominik Ritter 2019-03-05 22:52:48 +01:00
commit 6bf7498b54
2 changed files with 47 additions and 0 deletions

View file

@ -0,0 +1,44 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: ''
assignees: ''
---
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?
#### 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?

View file

@ -0,0 +1,38 @@
---
name: Performance Issue
about: For performance Issues
title: "[Performance]"
labels: performance
assignees: ''
---
Sorry to hear that the performance of P9K is not adequate. To fix this, please provide us with some hints.
### Your Hardware
Disk I/O is critical for P9K, so do you use a spinning disk, or a SSD?
### Virtualization
Do you use P9K in some sort of virtualization? This is also the case, if you use WSL on Windows..
### How Fast is Fast
Could you quantify how fast the specific segment is, that you think is slow?
For example, if you think the `vcs` segment is slow, could you execute this command in the directory, where the segment is slow:
```zsh
time (repeat 10; do; prompt_vcs left 1 false >/dev/null; done;)
```
Also, please provide us with some context around the segment. In the `vcs` example:
- How big is the repo?
- Does it contain a lot of untracked files?
- Does it contain a lot of git submodules?
- Does it contain a lot of files in general?
Additionally, you could install [zsh-prompt-benchmark](https://github.com/romkatv/zsh-prompt-benchmark), to benchmark the general performance of ZSH and P9K.
If you don't know which segment is slow, could you remove one by one, and spot the one that made the greatest impact?