diff options
author | Carl Smedstad <carl.smedstad@protonmail.com> | 2021-05-04 19:19:27 +0200 |
---|---|---|
committer | Hisham Muhammad <hisham@gobolinux.org> | 2021-05-05 11:23:35 -0300 |
commit | 7a9a69290610679a7f7fe0bc350250699d9ce9bf (patch) | |
tree | e010fd4320570fdacd75e0d3ece02a204c1423b2 | |
parent | f33aa0125f9d8c94049c162a8fdec54582ade205 (diff) | |
download | luarocks-7a9a69290610679a7f7fe0bc350250699d9ce9bf.tar.gz luarocks-7a9a69290610679a7f7fe0bc350250699d9ce9bf.tar.bz2 luarocks-7a9a69290610679a7f7fe0bc350250699d9ce9bf.zip |
Add issue templates for bugs and enhancements
The issue tracker does unfortunately contain quite a lot of low-quality
issues. I think issue templates can improve this for the future.
Adapted from these templates:
https://github.com/swaywm/sway/tree/master/.github/ISSUE_TEMPLATE
-rw-r--r-- | .github/ISSUE_TEMPLATE/bug_report.md | 31 | ||||
-rw-r--r-- | .github/ISSUE_TEMPLATE/enhancement.md | 11 |
2 files changed, 42 insertions, 0 deletions
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 00000000..85b3c465 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md | |||
@@ -0,0 +1,31 @@ | |||
1 | --- | ||
2 | name: Bugs | ||
3 | about: Bugs and unintented behaviour | ||
4 | labels: 'bug' | ||
5 | |||
6 | --- | ||
7 | |||
8 | ### Please read the following before submitting: | ||
9 | - Please do NOT submit bug reports for questions. Ask questions in the [Gitter | ||
10 | chat-room](https://gitter.im/luarocks/luarocks). | ||
11 | - Please do NOT submit duplicate bug reports. Look through the [issue | ||
12 | tracker](https://github.com/luarocks/luarocks/issues) before submitting. | ||
13 | |||
14 | ### Please fill out the following: | ||
15 | - **Platform:** | ||
16 | - Windows/Linux/MacOS. | ||
17 | |||
18 | - **LuaRocks version:** | ||
19 | - `luarocks --version` | ||
20 | |||
21 | - **Configuration file:** | ||
22 | - Please try to produce with the default configuration. | ||
23 | - If you cannot reproduce with the default configuration, please try to find | ||
24 | the minimal configuration to reproduce. | ||
25 | - Upload the config to a pastebin such as gist.github.com. | ||
26 | |||
27 | - **LuaRocks output from when the issue occurred:** | ||
28 | - Use the `--verbose` flag. | ||
29 | |||
30 | - **Description:** | ||
31 | - The steps you took in plain English to reproduce the problem. | ||
diff --git a/.github/ISSUE_TEMPLATE/enhancement.md b/.github/ISSUE_TEMPLATE/enhancement.md new file mode 100644 index 00000000..fb03b0f9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/enhancement.md | |||
@@ -0,0 +1,11 @@ | |||
1 | --- | ||
2 | name: Enhancements | ||
3 | about: New functionality | ||
4 | labels: 'enhancement' | ||
5 | |||
6 | --- | ||
7 | |||
8 | ### Please fill out the following: | ||
9 | - **Description:** | ||
10 | - Please describe in plain English what the enhancement is and what the use case | ||
11 | is. | ||