You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Apr 24, 2020. It is now read-only.
Copy file name to clipboardExpand all lines: .github/ISSUE_TEMPLATE/ISSUE_TEMPLATE.md
+11-2
Original file line number
Diff line number
Diff line change
@@ -1,3 +1,12 @@
1
+
---
2
+
name: Bug report
3
+
about: Create a report to help us improve
4
+
title: ''
5
+
labels: ''
6
+
assignees: ''
7
+
8
+
---
9
+
1
10
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!
2
11
3
12
### Before Opening a Bug
@@ -14,11 +23,11 @@ Most issues are best explained with a screenshot. Please share one if you can!
14
23
15
24
#### Have you tried to debug or fix it?
16
25
17
-
18
26
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!
19
27
20
28
#### Environment Information
21
-
This information will help us understand your configuration.
29
+
30
+
This information will help us understand your configuration.
22
31
23
32
- What version of ZSH are you using? You can use `zsh --version` to see this.
24
33
- Do you use a ZSH framework (e.g., Oh-My-ZSH, Antigen)?
Sorry to hear that the performance of P9K is not adequate. To fix this, please provide us with some hints.
11
+
12
+
### Your Hardware
13
+
14
+
Disk I/O is critical for P9K, so do you use a spinning disk, or a SSD?
15
+
16
+
### Virtualization
17
+
18
+
Do you use P9K in some sort of virtualization? This is also the case, if you use WSL on Windows..
19
+
20
+
### How Fast is Fast
21
+
22
+
Could you quantify how fast the specific segment is, that you think is slow?
23
+
For example, if you think the `vcs` segment is slow, could you execute this command in the directory, where the segment is slow:
24
+
25
+
```zsh
26
+
time (repeat 10;do; prompt_vcs left 1 false>/dev/null;done;)
27
+
```
28
+
29
+
Also, please provide us with some context around the segment. In the `vcs` example:
30
+
31
+
- How big is the repo?
32
+
- Does it contain a lot of untracked files?
33
+
- Does it contain a lot of git submodules?
34
+
- Does it contain a lot of files in general?
35
+
36
+
Additionally, you could install [zsh-prompt-benchmark](https://github.com/romkatv/zsh-prompt-benchmark), to benchmark the general performance of ZSH and P9K.
37
+
38
+
If you don't know which segment is slow, could you remove one by one, and spot the one that made the greatest impact?
Copy file name to clipboardExpand all lines: .github/PULL_REQUEST_TEMPLATE.md
+8-7
Original file line number
Diff line number
Diff line change
@@ -14,19 +14,20 @@ Once you have submitted your PR, P9k core contributors will review the code and
14
14
Please follow this template for creating your PR:
15
15
16
16
#### Title
17
+
17
18
Please make the title of your PR descriptive! If appropriate, please prefix the title with one of these tags:
18
19
19
-
-[Bugfix]
20
-
-[New Segment]
21
-
-[Docs]
22
-
-[Enhancement]
23
-
20
+
-[Bugfix]
21
+
-[New Segment]
22
+
-[Docs]
23
+
-[Enhancement]
24
+
24
25
#### Description
26
+
25
27
Please describe the contribution your PR makes! Screenshots are especially helpful, here, if it's a new segment.
26
28
27
29
If your PR is addressing an issue, please reference the Issue number here.
28
30
29
31
#### Questions
30
-
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!
31
-
32
32
33
+
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!
0 commit comments