]> git.sur5r.net Git - i3/i3/commitdiff
add specific GitHub issue templates 3441/head
authorMichael Stapelberg <michael@stapelberg.de>
Sun, 7 Oct 2018 18:41:42 +0000 (20:41 +0200)
committerMichael Stapelberg <michael@stapelberg.de>
Sun, 7 Oct 2018 18:41:42 +0000 (20:41 +0200)
I learnt about this from the GitHub blog:
https://blog.github.com/2018-05-02-issue-template-improvements/

.github/ISSUE_TEMPLATE.md
.github/ISSUE_TEMPLATE/bug_report.md [new file with mode: 0644]
.github/ISSUE_TEMPLATE/feature_request.md [new file with mode: 0644]

index 96f68d90a117ba86ba7b1e43290a078b734846bb..f2c55972ec872695bbb869f220a2865b2d6935b7 100644 (file)
@@ -12,10 +12,16 @@ PLEASE HELP US PROCESS GITHUB ISSUES FASTER BY PROVIDING THE FOLLOWING INFORMATI
 </pre>
 
 ## Current Behavior
-<!-- Describe the current behavior, e.g., »When pressing Alt+j (focus left), the window above the current window is focused.« -->
+<!--
+Describe the current behavior,
+e.g., »When pressing Alt+j (focus left), the window above the current window is focused.«
+-->
 
 ## Expected Behavior
-<!-- Describe the desired behavior you expect after mitigation of the issue, e.g., »The window left next to the current window should be focused.« -->
+<!--
+Describe the desired behavior you expect after mitigation of the issue,
+e.g., »The window left next to the current window should be focused.«
+-->
 
 ## Reproduction Instructions
 <!--
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
new file mode 100644 (file)
index 0000000..910b0fc
--- /dev/null
@@ -0,0 +1,71 @@
+---
+name: Bug report
+about: Create a report to help us improve
+---
+
+<!--
+PLEASE HELP US PROCESS GITHUB ISSUES FASTER BY PROVIDING THE FOLLOWING INFORMATION.
+-->
+
+## I'm submitting a…
+<!-- Please check one of the following options with "x" -->
+<pre>
+[x] Bug
+[ ] Feature Request
+[ ] Documentation Request
+[ ] Other (Please describe in detail)
+</pre>
+
+## Current Behavior
+<!--
+Describe the current behavior,
+e.g., »When pressing Alt+j (focus left), the window above the current window is focused.«
+-->
+
+## Expected Behavior
+<!--
+Describe the desired behavior you expect after mitigation of the issue,
+e.g., »The window left next to the current window should be focused.«
+-->
+
+## Reproduction Instructions
+<!--
+Please provide detailed instructions on how the bug can be reproduced.
+E.g., »Open three windows in a V[A H[B C]] layout on a new workspace«
+-->
+
+## Environment
+<!--
+Please include your exact i3 version.
+Note that we only support the latest major release and the current development version. If you are using an older version of i3, please first update to the current release version and reproduce the issue there.
+-->
+Output of `i3 --moreversion 2>&-`:
+<pre>
+i3 version: 
+</pre>
+
+<!--
+Please include your (complete) i3 config with which the issue occurs. You can either paste the file directly or provide a link to a service such as pastebin.
+
+If you would like to help debugging the issue, please try to reduce the config such that it is as close to the default config as possible while still reproducing the issue. This can help us bisect the root cause.
+-->
+<pre>
+</pre>
+
+<!--
+Providing a logfile can help us trace the root cause of an issue much quicker. You can learn how to generate the logfile here:
+https://i3wm.org/docs/debugging.html
+
+Providing the logfile is optional.
+-->
+<pre>
+Logfile URL:
+</pre>
+
+<!--
+Please also answer the questions below to help us process your issue faster. If you have any other information to share, please add it here as well.
+-->
+<pre>
+- Linux Distribution & Version:
+- Are you using a compositor (e.g., xcompmgr or compton):
+</pre>
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
new file mode 100644 (file)
index 0000000..e1c169a
--- /dev/null
@@ -0,0 +1,47 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+---
+
+<!--
+PLEASE HELP US PROCESS GITHUB ISSUES FASTER BY PROVIDING THE FOLLOWING INFORMATION.
+-->
+
+## I'm submitting a…
+<!-- Please check one of the following options with "x" -->
+<pre>
+[ ] Bug
+[x] Feature Request
+[ ] Documentation Request
+[ ] Other (Please describe in detail)
+</pre>
+
+## Current Behavior
+<!--
+Describe the current behavior,
+e.g., »When pressing Alt+j (focus left), the window above the current window is focused.«
+-->
+
+## Desired Behavior
+<!--
+Describe the desired behavior you expect after mitigation of the issue,
+e.g., »The window left next to the current window should be focused.«
+-->
+
+## Environment
+<!--
+Please include your exact i3 version.
+Note that we only support the latest major release and the current development version. If you are using an older version of i3, please first update to the current release version and reproduce the issue there.
+-->
+Output of `i3 --moreversion 2>&-`:
+<pre>
+i3 version: 
+</pre>
+
+<!--
+Please also answer the questions below to help us process your issue faster. If you have any other information to share, please add it here as well.
+-->
+<pre>
+- Linux Distribution & Version:
+- Are you using a compositor (e.g., xcompmgr or compton):
+</pre>