mirror of
https://github.com/romkatv/powerlevel10k.git
synced 2024-11-11 08:00:06 +00:00
Merge pull request #1178 from dritter/performance_issue_template
Add Performance Issue Template
This commit is contained in:
commit
b4ace4ea2d
3 changed files with 57 additions and 9 deletions
|
@ -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!
|
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
|
### Before Opening a Bug
|
||||||
|
@ -14,10 +23,10 @@ Most issues are best explained with a screenshot. Please share one if you can!
|
||||||
|
|
||||||
#### Have you tried to debug or fix it?
|
#### 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!
|
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
|
#### Environment Information
|
||||||
|
|
||||||
This information will help us understand your configuration.
|
This information will help us understand your configuration.
|
||||||
|
|
||||||
- What version of ZSH are you using? You can use `zsh --version` to see this.
|
- What version of ZSH are you using? You can use `zsh --version` to see this.
|
38
.github/ISSUE_TEMPLATE/PERFORMANCE_ISSUE_TEMPLATE.md
vendored
Normal file
38
.github/ISSUE_TEMPLATE/PERFORMANCE_ISSUE_TEMPLATE.md
vendored
Normal 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?
|
5
.github/PULL_REQUEST_TEMPLATE.md
vendored
5
.github/PULL_REQUEST_TEMPLATE.md
vendored
|
@ -14,6 +14,7 @@ Once you have submitted your PR, P9k core contributors will review the code and
|
||||||
Please follow this template for creating your PR:
|
Please follow this template for creating your PR:
|
||||||
|
|
||||||
#### Title
|
#### Title
|
||||||
|
|
||||||
Please make the title of your PR descriptive! If appropriate, please prefix the title with one of these tags:
|
Please make the title of your PR descriptive! If appropriate, please prefix the title with one of these tags:
|
||||||
|
|
||||||
- [Bugfix]
|
- [Bugfix]
|
||||||
|
@ -22,11 +23,11 @@ Please make the title of your PR descriptive! If appropriate, please prefix the
|
||||||
- [Enhancement]
|
- [Enhancement]
|
||||||
|
|
||||||
#### Description
|
#### Description
|
||||||
|
|
||||||
Please describe the contribution your PR makes! Screenshots are especially helpful, here, if it's a new segment.
|
Please describe the contribution your PR makes! Screenshots are especially helpful, here, if it's a new segment.
|
||||||
|
|
||||||
If your PR is addressing an issue, please reference the Issue number here.
|
If your PR is addressing an issue, please reference the Issue number here.
|
||||||
|
|
||||||
#### Questions
|
#### Questions
|
||||||
|
|
||||||
Is there something in your PR you're not sure about or need help with? Is there a particular piece of code you would like feedback on? Let us know here!
|
Is there something in your PR you're not sure about or need help with? Is there a particular piece of code you would like feedback on? Let us know here!
|
||||||
|
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue