From 7a9a69290610679a7f7fe0bc350250699d9ce9bf Mon Sep 17 00:00:00 2001 From: Carl Smedstad Date: Tue, 4 May 2021 19:19:27 +0200 Subject: 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 --- .github/ISSUE_TEMPLATE/bug_report.md | 31 +++++++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/enhancement.md | 11 +++++++++++ 2 files changed, 42 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/enhancement.md 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 @@ +--- +name: Bugs +about: Bugs and unintented behaviour +labels: 'bug' + +--- + +### Please read the following before submitting: +- Please do NOT submit bug reports for questions. Ask questions in the [Gitter + chat-room](https://gitter.im/luarocks/luarocks). +- Please do NOT submit duplicate bug reports. Look through the [issue + tracker](https://github.com/luarocks/luarocks/issues) before submitting. + +### Please fill out the following: +- **Platform:** + - Windows/Linux/MacOS. + +- **LuaRocks version:** + - `luarocks --version` + +- **Configuration file:** + - Please try to produce with the default configuration. + - If you cannot reproduce with the default configuration, please try to find + the minimal configuration to reproduce. + - Upload the config to a pastebin such as gist.github.com. + +- **LuaRocks output from when the issue occurred:** + - Use the `--verbose` flag. + +- **Description:** + - 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 @@ +--- +name: Enhancements +about: New functionality +labels: 'enhancement' + +--- + +### Please fill out the following: +- **Description:** + - Please describe in plain English what the enhancement is and what the use case + is. -- cgit v1.2.3-55-g6feb