From 777d92b2ed2f58dffd30554bdafc5141e5dd4843 Mon Sep 17 00:00:00 2001 From: Frank LENORMAND Date: Mon, 13 Sep 2021 10:38:58 +0300 Subject: [PATCH 1/8] github bug_report: Migrate template to YAML --- .github/ISSUE_TEMPLATE/bug_report.md | 11 ----------- .github/ISSUE_TEMPLATE/bug_report.yml | 28 +++++++++++++++++++++++++++ 2 files changed, 28 insertions(+), 11 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index ffe99203..00000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -name: Bug report -about: Report an unexpected behaviour with the editor -labels: bug ---- - -### Steps - -### Outcome - -### Expected diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 00000000..871011d5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,28 @@ +name: Bug report +description: Report an unexpected behaviour with the editor +labels: bug +title: "[BUG] " +body: + + - 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 From c04391867de44164d619cd0dbc9dae32d40d4372 Mon Sep 17 00:00:00 2001 From: Frank LENORMAND Date: Mon, 13 Sep 2021 10:43:56 +0300 Subject: [PATCH 2/8] github contact: Add link to IRC --- .github/ISSUE_TEMPLATE/config.yml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 0086358d..0130b979 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.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 From 156b5a5e29551913ab7994f33560a4b59019ac79 Mon Sep 17 00:00:00 2001 From: Frank LENORMAND Date: Mon, 13 Sep 2021 10:49:25 +0300 Subject: [PATCH 3/8] github bug_report: Require a Kakoune version --- .github/ISSUE_TEMPLATE/bug_report.yml | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 871011d5..8749ae93 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -4,6 +4,14 @@ labels: bug title: "[BUG] " body: + - 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" From 6d38f9e63d6466bc3f1cab3a94b14cd38f218a37 Mon Sep 17 00:00:00 2001 From: Frank LENORMAND Date: Mon, 13 Sep 2021 11:08:08 +0300 Subject: [PATCH 4/8] github bug_report: Additional information field --- .github/ISSUE_TEMPLATE/bug_report.yml | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 8749ae93..3c25cea5 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -34,3 +34,16 @@ body: 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 From 358de2b2bc90e2c1db72e3070f965e50d7c7a0e6 Mon Sep 17 00:00:00 2001 From: Frank LENORMAND Date: Mon, 13 Sep 2021 11:15:49 +0300 Subject: [PATCH 5/8] github bug_report: Preamble --- .github/ISSUE_TEMPLATE/bug_report.yml | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 3c25cea5..83ec4d15 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -4,6 +4,13 @@ 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" From 3eed5fdf8275d66ffe8131f4730588984ff3d52c Mon Sep 17 00:00:00 2001 From: Frank LENORMAND Date: Mon, 13 Sep 2021 11:55:15 +0300 Subject: [PATCH 6/8] github crash_report: Migrate template to YAML --- .github/ISSUE_TEMPLATE/crash_report.md | 15 ------ .github/ISSUE_TEMPLATE/crash_report.yml | 62 +++++++++++++++++++++++++ 2 files changed, 62 insertions(+), 15 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/crash_report.md create mode 100644 .github/ISSUE_TEMPLATE/crash_report.yml diff --git a/.github/ISSUE_TEMPLATE/crash_report.md b/.github/ISSUE_TEMPLATE/crash_report.md deleted file mode 100644 index 43bbe2f8..00000000 --- a/.github/ISSUE_TEMPLATE/crash_report.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -name: Crash report -about: Report a crash of the editor while in-use -labels: bug, crash ---- - - - -### Steps - -### Outcome/Stacktrace diff --git a/.github/ISSUE_TEMPLATE/crash_report.yml b/.github/ISSUE_TEMPLATE/crash_report.yml new file mode 100644 index 00000000..059d123e --- /dev/null +++ b/.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 From b05e300e9650e8bdbd5364dff7a54be2de1f5afa Mon Sep 17 00:00:00 2001 From: Frank LENORMAND Date: Mon, 13 Sep 2021 12:06:02 +0300 Subject: [PATCH 7/8] github feature_request: Migrate template to YAML --- .github/ISSUE_TEMPLATE/feature_request.md | 17 ------------- .github/ISSUE_TEMPLATE/feature_request.yml | 28 ++++++++++++++++++++++ 2 files changed, 28 insertions(+), 17 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 6775dc60..00000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -name: Feature request -about: Ask for a feature to be implemented and included in the next release -labels: feature request ---- - - - -### Feature - -### Usecase diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 00000000..3cdbbd3f --- /dev/null +++ b/.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 From 2a4bee4564253ee2b22b8886710f10cef4fb4c2c Mon Sep 17 00:00:00 2001 From: Frank LENORMAND Date: Mon, 13 Sep 2021 12:08:33 +0300 Subject: [PATCH 8/8] github question: Migrate template to YAML --- .github/ISSUE_TEMPLATE/question.md | 13 ------------- .github/ISSUE_TEMPLATE/question.yml | 19 +++++++++++++++++++ 2 files changed, 19 insertions(+), 13 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/question.md create mode 100644 .github/ISSUE_TEMPLATE/question.yml diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md deleted file mode 100644 index 73c2f38b..00000000 --- a/.github/ISSUE_TEMPLATE/question.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -name: Question -about: Couldn't find an answer in the documentation? Ask away! -labels: question ---- - - diff --git a/.github/ISSUE_TEMPLATE/question.yml b/.github/ISSUE_TEMPLATE/question.yml new file mode 100644 index 00000000..aa1c82a8 --- /dev/null +++ b/.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