Merge remote-tracking branch 'lenormf/github_templates'

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,11 +0,0 @@
----
-name: Bug report
-about: Report an unexpected behaviour with the editor
-labels: bug
----
-
-### Steps <!-- how to reproduce the issue? -->
-
-### Outcome <!-- what is the result of the above steps? -->
-
-### Expected <!-- what should have been the result of the above steps? -->

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,56 @@
+name: Bug report
+description: Report an unexpected behaviour with the editor
+labels: bug
+title: "[BUG] "
+body:
+
+    - type: markdown
+      attributes:
+        value: |
+            Please make sure to [search issues](https://github.com/mawww/kakoune/issues?q=is%3Aissue) before creating a new one, to avoid duplicates and centralise conversations.
+
+            If you need to have a question about the editor itself (options, behaviour, code…) answered, make sure to check the [documentation](https://github.com/mawww/kakoune/tree/master/doc/pages) (also available via the `doc` command in the editor) or drop by [IRC](https://web.libera.chat/?channels=#kakoune) to get instant feedback.
+
+    - type: input
+      attributes:
+          label: "Version of Kakoune"
+          description: "If unsure, use the output of command: `kak -version`"
+          placeholder: "v2020.12.31"
+      validations:
+          required: true
+
+    - type: textarea
+      attributes:
+          label: "Reproducer"
+          description: "What are the steps to follow to reproduce the issue?"
+          placeholder: |
+              If any specific configuration or environment settings are required to reproduce the issue, also describe them here.
+      validations:
+        required: true
+
+    - type: textarea
+      attributes:
+          label: "Outcome"
+          description: "What is the outcome of the reproducing steps above?"
+      validations:
+        required: true
+
+    - type: textarea
+      attributes:
+          label: "Expectations"
+          description: "What was the expected outcome of the reproducing steps above?"
+      validations:
+        required: true
+
+    - type: textarea
+      attributes:
+          label: "Additional information"
+          description: "Any other information that may be relevant to diagnosing the issue should be documented here"
+          placeholder: |
+              Examples of relevant information:
+
+              * What OS and distribution are you using?
+              * Are you running an experimental branch (i.e. not `master`)?
+              * Is the issue reproducible in other terminals?
+      validations:
+        required: false

.github/ISSUE_TEMPLATE/config.yml

@@ -1 +1,5 @@
 blank_issues_enabled: true
+contact_links:
+    - name: IRC channel
+      url: https://web.libera.chat/?channels=#kakoune
+      about: Ask your questions to get real time support on the official channel

.github/ISSUE_TEMPLATE/crash_report.md

@@ -1,15 +0,0 @@
----
-name: Crash report
-about: Report a crash of the editor while in-use
-labels: bug, crash
----
-
-<!--
-If you have a reproducer for the crash you've experienced, please make sure
-to include a demangled stacktrace (i.e. pass it to `c++filt`) produced
-by an instance of the editor built in debug mode (`make debug=yes`).
--->
-
-### Steps <!-- what steps allow reproducing the crash? -->
-
-### Outcome/Stacktrace <!-- what is the outcome of the above steps? is there any stacktrace? -->

.github/ISSUE_TEMPLATE/crash_report.yml

@@ -0,0 +1,62 @@
+name: Crash report
+description: Report a crash of the editor while in-use
+labels: bug, crash
+title: "[BUG][CRASH] "
+body:
+
+    - type: markdown
+      attributes:
+        value: |
+            Please make sure to [search issues](https://github.com/mawww/kakoune/issues?q=is%3Aissue) before creating a new one, to avoid duplicates and centralise conversations.
+
+            If you need to have a question about the editor itself (options, behaviour, code…) answered, make sure to check the [documentation](https://github.com/mawww/kakoune/tree/master/doc/pages) (also available via the `doc` command in the editor) or drop by [IRC](https://web.libera.chat/?channels=#kakoune) to get instant feedback.
+
+    - type: input
+      attributes:
+          label: "Version of Kakoune"
+          description: "If unsure, use the output of command: `kak -version`"
+          placeholder: "v2020.12.31"
+      validations:
+          required: true
+
+    - type: textarea
+      attributes:
+          label: "Reproducer"
+          description: "What are the steps to follow to reproduce the issue?"
+          placeholder: |
+              If any specific configuration or environment settings are required to reproduce the issue, also describe them here.
+      validations:
+        required: true
+
+    - type: textarea
+      attributes:
+          label: "Outcome"
+          description: "What is the outcome of the reproducing steps above?"
+          placeholder: |
+              If the editor printed any error messages, or if you managed to obtain a backtrace, also document them here. Make sure to demangle the stacktrace by passing it to the `c++filt` command.
+
+              Note that triggering the issue in the editor compiled in debug mode will produce more helpful messages, please consider re-building with `make debug=yes` to help us out.
+      validations:
+        required: true
+
+    - type: textarea
+      attributes:
+          label: "Expectations"
+          description: "What was the expected outcome of the reproducing steps above?"
+          placeholder: |
+              If the reproducing steps are self-evident, the expectations are simply “the editor should not crash”. In that case, you may ignore this field.
+      validations:
+        required: false
+
+    - type: textarea
+      attributes:
+          label: "Additional information"
+          description: "Any other information that may be relevant to diagnosing the issue should be documented here"
+          placeholder: |
+              Examples of relevant information:
+
+              * What OS and distribution are you using?
+              * Are you running an experimental branch (i.e. not `master`)?
+              * Is the issue reproducible in other terminals?
+      validations:
+        required: false

.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,17 +0,0 @@
----
-name: Feature request
-about: Ask for a feature to be implemented and included in the next release
-labels: feature request
----
-
-<!--
-Please make sure that no request has already been made for your feature
-by checking the issue tracker (tag: `feature request`). If it was to be the
-case, feel free to post a reply in the already existing issue, indicating
-that you're interested (and possibly the use you would make for the feature,
-if not already mentioned).
--->
-
-### Feature <!-- what do you want implemented that is not already available in the development version? -->
-
-### Usecase <!-- what use do you have for the feature, if it's not self-evident (e.g. a hook, option)? -->

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,28 @@
+name: Feature request
+description: Ask for a feature to be implemented and included in the next release
+labels: feature request
+title: "[REQUEST] "
+body:
+
+    - type: markdown
+      attributes:
+        value: |
+            Please make sure to [search issues](https://github.com/mawww/kakoune/issues?q=is%3Aissue) before creating a new one, to avoid duplicates and centralise conversations.
+
+            If you need to have a question about the editor itself (options, behaviour, code…) answered, make sure to check the [documentation](https://github.com/mawww/kakoune/tree/master/doc/pages) (also available via the `doc` command in the editor) or drop by [IRC](https://web.libera.chat/?channels=#kakoune) to get instant feedback.
+
+    - type: textarea
+      attributes:
+          label: "Feature"
+          description: "What do you want implemented that is not already available in the development version?"
+      validations:
+        required: true
+
+    - type: textarea
+      attributes:
+          label: "Usecase"
+          description: "What use do you have for the requested feature?"
+          placeholder: |
+              If the feature's usecase is self-evident, such as a hook or an option whose name hints at a functionality unequivocally, you may ignore this field.
+      validations:
+        required: false

.github/ISSUE_TEMPLATE/question.md

@@ -1,13 +0,0 @@
----
-name: Question
-about: Couldn't find an answer in the documentation? Ask away!
-labels: question
----
-
-<!--
-Please make sure that you check the onboard documentation (`:doc …`),
-the community wiki (hosted on Github) and other issues before creating an
-issue for your question.
-
-You can also drop by our IRC channel to get instant (hopefully) feedback.
--->

.github/ISSUE_TEMPLATE/question.yml

@@ -0,0 +1,19 @@
+name: Question
+description: Couldn't find an answer in the documentation? Ask away!
+labels: question
+title: "[QUESTION] "
+body:
+
+    - type: markdown
+      attributes:
+        value: |
+            Please make sure to [search issues](https://github.com/mawww/kakoune/issues?q=is%3Aissue) before creating a new one, to avoid duplicates and centralise conversations.
+
+            If you need to have a question about the editor itself (options, behaviour, code…) answered, make sure to check the [documentation](https://github.com/mawww/kakoune/tree/master/doc/pages) (also available via the `doc` command in the editor) or drop by [IRC](https://web.libera.chat/?channels=#kakoune) to get instant feedback.
+
+    - type: textarea
+      attributes:
+          label: "Question"
+          description: "Couldn't find an answer in the documentation? Ask away!"
+      validations:
+        required: true