Skip to content
Permalink
Browse files

Add Performance Issue Template

  • Loading branch information...
dritter committed Mar 5, 2019
1 parent e599057 commit 6bf7498b544115cfa67330e6a03b371261872f21
@@ -1,3 +1,12 @@
---
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
@@ -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?

0 comments on commit 6bf7498

Please sign in to comment.
You can’t perform that action at this time.