From def236f1ae042f245bf72f3807c488f6bde28db3 Mon Sep 17 00:00:00 2001 From: Jo Stichbury Date: Mon, 22 Jan 2024 11:24:57 +0000 Subject: [PATCH] Revise templates for GitHub issues (#3538) * Minor change to design doc contents Signed-off-by: Jo Stichbury * Rename design doc Signed-off-by: Jo Stichbury * Revise doc-improvement.md Signed-off-by: Jo Stichbury * Revise doc-improvement.md Signed-off-by: Jo Stichbury * Update doc-improvement.md Signed-off-by: Jo Stichbury * Lint Signed-off-by: Jo Stichbury --------- Signed-off-by: Jo Stichbury --- .github/ISSUE_TEMPLATE/doc-improvement.md | 7 ++++--- .../{design-doc.md => software_design_proposal.md} | 4 ++-- 2 files changed, 6 insertions(+), 5 deletions(-) rename .github/ISSUE_TEMPLATE/{design-doc.md => software_design_proposal.md} (92%) diff --git a/.github/ISSUE_TEMPLATE/doc-improvement.md b/.github/ISSUE_TEMPLATE/doc-improvement.md index 41084d26a7..64523d37bc 100644 --- a/.github/ISSUE_TEMPLATE/doc-improvement.md +++ b/.github/ISSUE_TEMPLATE/doc-improvement.md @@ -8,7 +8,8 @@ labels: 'Component: Documentation' ## Description -## Context - +### Documentation page (if applicable) + -* Documentation page (if applicable): +## Context + diff --git a/.github/ISSUE_TEMPLATE/design-doc.md b/.github/ISSUE_TEMPLATE/software_design_proposal.md similarity index 92% rename from .github/ISSUE_TEMPLATE/design-doc.md rename to .github/ISSUE_TEMPLATE/software_design_proposal.md index 43f70cb12e..3b200468f5 100644 --- a/.github/ISSUE_TEMPLATE/design-doc.md +++ b/.github/ISSUE_TEMPLATE/software_design_proposal.md @@ -1,8 +1,8 @@ --- -name: Software design documentation +name: Software design proposal about: To propose and request comments on a software design decision title: '' -labels: 'Type: Design Documentation' +labels: 'Type: Design Proposal' assignees: '' ---