diff options
| -rw-r--r-- | .github/ISSUE_TEMPLATE/ISSUE_TEMPLATE.md (renamed from .github/ISSUE_TEMPLATE.md) | 13 | ||||
| -rw-r--r-- | .github/ISSUE_TEMPLATE/PERFORMANCE_ISSUE_TEMPLATE.md | 38 | ||||
| -rw-r--r-- | .github/PULL_REQUEST_TEMPLATE.md | 15 | ||||
| -rw-r--r-- | README.md | 1 |
4 files changed, 58 insertions, 9 deletions
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE/ISSUE_TEMPLATE.md index 01fbc413..5070d714 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE/ISSUE_TEMPLATE.md @@ -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 @@ -14,11 +23,11 @@ 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. + +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)? diff --git a/.github/ISSUE_TEMPLATE/PERFORMANCE_ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE/PERFORMANCE_ISSUE_TEMPLATE.md new file mode 100644 index 00000000..9d852db0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/PERFORMANCE_ISSUE_TEMPLATE.md @@ -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?
\ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 4ade8059..76b1fac9 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -14,19 +14,20 @@ Once you have submitted your PR, P9k core contributors will review the code and Please follow this template for creating your PR: #### Title + Please make the title of your PR descriptive! If appropriate, please prefix the title with one of these tags: - - [Bugfix] - - [New Segment] - - [Docs] - - [Enhancement] - +- [Bugfix] +- [New Segment] +- [Docs] +- [Enhancement] + #### Description + 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. #### 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! @@ -208,6 +208,7 @@ systems without a battery). It is supported on both OSX and Linux (note that it |`POWERLEVEL9K_BATTERY_LOW_THRESHOLD`|`10`|Threshold to consider battery level critical.| |`POWERLEVEL9K_BATTERY_LOW_COLOR`|`"red"`|Color to indicate critically low charge level.| |`POWERLEVEL9K_BATTERY_VERBOSE`|`true`|Display time remaining next to battery level.| +|`POWERLEVEL9K_BATTERY_HIDE_ABOVE_THRESHOLD`|`unset`|Threshold from which the battery segment should not be displayed.| Note that you can [modify the `_FOREGROUND` color](https://github.com/bhilburn/powerlevel9k/wiki/Stylizing-Your-Prompt#segment-color-customization) |