From 7fe681c5c9c7a0f96d0480f20204e13ae097a1f8 Mon Sep 17 00:00:00 2001 From: Stan Ulbrych Date: Mon, 26 Jan 2026 21:35:32 +0000 Subject: [PATCH 1/3] Add docs template --- .github/ISSUE_TEMPLATE/documentation.md | 9 --------- .github/ISSUE_TEMPLATE/documentation.yml | 14 ++++++++++++++ 2 files changed, 14 insertions(+), 9 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/documentation.md create mode 100644 .github/ISSUE_TEMPLATE/documentation.yml diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md deleted file mode 100644 index 174fd39171d47d..00000000000000 --- a/.github/ISSUE_TEMPLATE/documentation.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -name: Documentation -about: Report a problem with the documentation -labels: "docs" ---- - -# Documentation - -(A clear and concise description of the issue.) diff --git a/.github/ISSUE_TEMPLATE/documentation.yml b/.github/ISSUE_TEMPLATE/documentation.yml new file mode 100644 index 00000000000000..79c5cff463bc60 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation.yml @@ -0,0 +1,14 @@ +name: Documentation +description: Report a problem with the documentation +labels: ["docs"] +body: + - type: markdown + attributes: + value: | + If the issue is trivial, for example a typo, an issue is not necessary. + - type: textarea + attributes: + label: "Documentation" + description: "A clear and concise description of the issue." + validations: + required: true From 6e9d3dcbd432d761db461bb76ed74225c645f3b3 Mon Sep 17 00:00:00 2001 From: Stan Ulbrych Date: Mon, 26 Jan 2026 21:38:00 +0000 Subject: [PATCH 2/3] Colour!!! --- .github/ISSUE_TEMPLATE/documentation.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/documentation.yml b/.github/ISSUE_TEMPLATE/documentation.yml index 79c5cff463bc60..7067b566700c73 100644 --- a/.github/ISSUE_TEMPLATE/documentation.yml +++ b/.github/ISSUE_TEMPLATE/documentation.yml @@ -5,7 +5,8 @@ body: - type: markdown attributes: value: | - If the issue is trivial, for example a typo, an issue is not necessary. + > [!IMPORTANT] + > If the issue is trivial, for example a typo, an issue is not necessary. - type: textarea attributes: label: "Documentation" From 1c852d856d11d4d0a525b8a63091f32c21f88ae9 Mon Sep 17 00:00:00 2001 From: Stan Ulbrych Date: Tue, 27 Jan 2026 19:00:35 +0000 Subject: [PATCH 3/3] reword --- .github/ISSUE_TEMPLATE/documentation.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/documentation.yml b/.github/ISSUE_TEMPLATE/documentation.yml index 7067b566700c73..543947d3572cc8 100644 --- a/.github/ISSUE_TEMPLATE/documentation.yml +++ b/.github/ISSUE_TEMPLATE/documentation.yml @@ -6,7 +6,7 @@ body: attributes: value: | > [!IMPORTANT] - > If the issue is trivial, for example a typo, an issue is not necessary. + > Trivial changes (for example typos) don’t require an issue before opening a PR. - type: textarea attributes: label: "Documentation"