summaryrefslogtreecommitdiff
path: root/.github
diff options
context:
space:
mode:
authorDominik Ritter <dritter03@googlemail.com>2018-06-29 00:54:34 +0300
committerDominik Ritter <dritter03@googlemail.com>2018-06-29 00:54:34 +0300
commitcda6ee926cb00db47aa1294fdf065b684abcf793 (patch)
treeb93072d60ec423387e5f8484fe90006896cac9d9 /.github
parent348617040b6985f21e1140c451747a8005249fb2 (diff)
Add github templates for issue reports and new pull requests
Diffstat (limited to '.github')
-rw-r--r--.github/ISSUE_TEMPLATE.md14
-rw-r--r--.github/PULL_REQUEST_TEMPLATE.md14
2 files changed, 28 insertions, 0 deletions
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
new file mode 100644
index 00000000..626450cd
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE.md
@@ -0,0 +1,14 @@
+Problems with powerlevel9k come with a lot of possible causes.
+The problem you have may arise from the used ZSH version to the
+configured font or even depend on the terminal emulator you are
+using.
+
+So, please help us a bit and describe your problem as detailed as
+possible. Here is a little questionnaire to help us ask the right
+questions:
+ - What does `zsh --version` give you?
+ - Do you use a ZSH framework?
+ - Which terminal emulator do you use?
+ - Which font do you use (for font related issues)?
+ - Which powerlevel9k mode do you use (`echo $POWERLEVEL9K_MODE`)?
+ - For font issues: Could you post the output of `debug/font-issues.zsh`?
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
new file mode 100644
index 00000000..8cf25fd0
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,14 @@
+Hey! Thanks for you contribution. To help you with that pull request,
+we have here some useful informations for you.
+
+Did you know:
+ - Our development happens on `next` branch. So should yours. Please
+ ensure your base is `next`. More information [here](https://github.com/bhilburn/powerlevel9k/wiki/Developer's-Guide).
+ - We have a lot of unit tests (in `test` dir). It would be awesome,
+ if you would add one for your feature.
+ - For manual tests there are Vagrant files and Docker files prepared.
+ Just have a look at the [test readme](https://github.com/bhilburn/powerlevel9k/blob/next/TESTS.md)
+ - Our [wiki](https://github.com/bhilburn/powerlevel9k/wiki) is quite
+ packed with loads of information about how to configure this theme.
+ If your feature has some flexpoint, the configuration help should
+ probably go there or in the README.