From f5bf6e80195f03e6952025db855f02c0dfa06a05 Mon Sep 17 00:00:00 2001 From: Justine Geffen Date: Tue, 28 Sep 2021 18:43:17 +0200 Subject: [PATCH] Update templates for issues (#1175) * Update doc_improvement.md Update templates: formatting, style, example links. * Update bug_report.md * Update enhancement.md * Fix merge Co-authored-by: Chen-I Lim <46905241+chenilim@users.noreply.github.com> --- .github/ISSUE_TEMPLATE/bug_report.md | 19 ++++++++++++------- .github/ISSUE_TEMPLATE/doc_improvement.md | 13 ++++++++----- .github/ISSUE_TEMPLATE/enhancement.md | 10 ++++++---- 3 files changed, 26 insertions(+), 16 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index f729317e8..92d80678e 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -7,22 +7,27 @@ assignees: '' --- -**Steps to reproduce the behavior:** +## Steps to reproduce the behavior + 1. Go to ... -2. Click on ... +2. Select ... 3. Scroll down to ... 4. See error -**Expected behavior:** +## Expected behavior + A clear and concise description of what you expected to happen. -**Screenshots:** -If applicable, add screenshots to help explain your problem. +## Screenshots + +If applicable, add screenshots to elaborate on the problem. + +## Edition and Platform -**Edition and Platform:** - Edition: Personal Desktop / Personal Server / Mattermost plugin - Version: [e.g. v0.9.0] - Browser and OS: [e.g. Chrome 91 on macOS, Edge 93 on Windows] -**Additional context:** +## Additional context + Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/doc_improvement.md b/.github/ISSUE_TEMPLATE/doc_improvement.md index d94c07f04..a3fa25668 100644 --- a/.github/ISSUE_TEMPLATE/doc_improvement.md +++ b/.github/ISSUE_TEMPLATE/doc_improvement.md @@ -7,11 +7,14 @@ assignees: '' --- -**Summary:** +## Summary + Concisely summarize improvement to documentation requested. -**Link to documentation page:** -If applicable, link to the documentation page and/or section where you feel the improvement could be added. E.g. `https://www.focalboard.com/guide/user/#renaming-boards` +## Link to documentation page -**(Optional) Additional context and/or screenshot:** -Add additional context and/or a screenshot of the product feature you would like explained in documentation. +If applicable, link to the documentation page and/or section where you feel the improvement could be added. E.g. `https://docs.mattermost.com/boards/accessing-boards.html` + +## (Optional) Additional context and/or screenshot + +Add additional context and/or a screenshot of the product feature you'd like explained in documentation. diff --git a/.github/ISSUE_TEMPLATE/enhancement.md b/.github/ISSUE_TEMPLATE/enhancement.md index aa6260a8c..2ed754c95 100644 --- a/.github/ISSUE_TEMPLATE/enhancement.md +++ b/.github/ISSUE_TEMPLATE/enhancement.md @@ -1,5 +1,5 @@ --- -name: Enhancement / Feature Idea +name: Enhancement/Feature Idea about: Suggest a new capability title: 'Feature Idea: ' labels: Enhancement @@ -7,10 +7,11 @@ assignees: '' --- -**Summary:** +## Summary + What the new capability is. -**How important this is to me and why:** +## How important this is to me and why Importance: High/Medium/Low @@ -19,5 +20,6 @@ Use cases: 2. 3. -**Additional context / similar features:** +## Additional context/similar features + Any examples of good implementations of this capability.