From a4cd5e45570fc5d3648c98450c2544490474403c Mon Sep 17 00:00:00 2001 From: Naoki Mizuno Date: Wed, 15 Jun 2016 17:23:20 +0900 Subject: [PATCH] Update ISSUE_TEMPLATE --- .github/CONTRIBUTING.md | 36 +++++++++++++++++++++++++ .github/ISSUE_TEMPLATE.md | 55 ++++++++++++++++++++++----------------- 2 files changed, 67 insertions(+), 24 deletions(-) create mode 100644 .github/CONTRIBUTING.md diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..4329dcf --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,36 @@ +Thank you for helping improve zplug! + +To make sure we can quickly assist you with any bugs, we have three requests: + +## 1. Remove the cache file and zcompdump + +Before moving on to the next step, make sure you have cleared the cache file +with `zplug clear` and removed the zcompdump file with `rm -f +$ZPLUG_HOME/zcompdump`. + +## 2. Reproduce the bug with a minimal **.zshrc** + +Remove as many lines in your **.zshrc** as possible, for example, if there's a problem with `zsh-syntax-highlighting`, try something like: + +```zsh + # Example minimal zshrc + source ~/.zplug/init.zsh + + zplug "zsh-users/zsh-syntax-highlighting" + + zplug check || zplug install + + zplug load +``` + +Sometimes the problem only manifests when there are two different plugins loaded. Knowing which two plugins will greatly help us come up with a fix. + +## 3. Share some system information + +By pasting the output of these three commands in your bug report, we can be certain we are testing the right thing for your setup: + +- [ ] `uname -a` +- [ ] `cat ~/.zshrc` +- [ ] `zsh --version` + +By following these two steps, we can assist with any problem much faster! diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index 4329dcf..2f50805 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,36 +1,43 @@ -Thank you for helping improve zplug! +## Problem Summary -To make sure we can quickly assist you with any bugs, we have three requests: +REPLACE ME -## 1. Remove the cache file and zcompdump +## System Information -Before moving on to the next step, make sure you have cleared the cache file -with `zplug clear` and removed the zcompdump file with `rm -f -$ZPLUG_HOME/zcompdump`. +- `uname -a` -## 2. Reproduce the bug with a minimal **.zshrc** + ``` +REPLACE ME + ``` -Remove as many lines in your **.zshrc** as possible, for example, if there's a problem with `zsh-syntax-highlighting`, try something like: +- zsh version + + ``` +REPLACE ME + ``` + +- zplug version/commit + + ``` +REPLACE ME + ``` + +## Minimal zshrc + +Create a minimal reproducing set of configurations for this issue. Please +remove all unnecessary parts! ```zsh - # Example minimal zshrc - source ~/.zplug/init.zsh +source ~/.zplug/init.zsh - zplug "zsh-users/zsh-syntax-highlighting" +# REPLACE ME +zplug 'foo/bar' - zplug check || zplug install - - zplug load +zplug load --verbose ``` -Sometimes the problem only manifests when there are two different plugins loaded. Knowing which two plugins will greatly help us come up with a fix. +## Steps to Reproduce -## 3. Share some system information - -By pasting the output of these three commands in your bug report, we can be certain we are testing the right thing for your setup: - -- [ ] `uname -a` -- [ ] `cat ~/.zshrc` -- [ ] `zsh --version` - -By following these two steps, we can assist with any problem much faster! +1. REPLACE ME +2. REPLACE ME +3. ...