From 7d213bf57f26b6bd6ab524ef4abe3af2e27be41c Mon Sep 17 00:00:00 2001 From: Marco Malavolti <marco.malavolti@gmail.com> Date: Sun, 29 Nov 2020 15:47:27 +0100 Subject: [PATCH] Enriched Description templates --- .gitlab/issue_templates/bug.md | 15 ++++++++------- .gitlab/issue_templates/feature_request.md | 14 ++++++++++++-- 2 files changed, 20 insertions(+), 9 deletions(-) diff --git a/.gitlab/issue_templates/bug.md b/.gitlab/issue_templates/bug.md index 6ae5500..12c510b 100644 --- a/.gitlab/issue_templates/bug.md +++ b/.gitlab/issue_templates/bug.md @@ -1,25 +1,27 @@ <!--- Please read this! -Before opening a new issue, make sure to search for keywords in the issues -filtered by the "bug" label: +Before opening a new issue, make sure to search for keywords in the issues filtered by the "bug" label: - https://gitlab.geant.org/marco.malavolti/eccs2/-/issues?label_name%5B%5D=bug -and verify the issue you're about to submit isn't a duplicate. +and verify that the issue you're about to submit isn't a duplicate. ---> ### Summary <!-- Summarize the bug encountered concisely. --> +### Context +<!-- Describe what are the benefits that the issue brings to other users --> + ### Steps to reproduce -<!-- Describe how one can reproduce the issue - this is very important. Please use an ordered list. --> +<!-- Describe how the issue can be reproduced - this is very important. Please use an ordered list. --> ### What is the current *bug* behavior? -<!-- Describe what actually happens. --> +<!-- Describe what is actually happening. --> ### What is the expected *correct* behavior? @@ -27,8 +29,7 @@ and verify the issue you're about to submit isn't a duplicate. ### Relevant logs and/or screenshots -<!-- Paste any relevant logs - please use code blocks (```) to format console output, logs, and code - as it's tough to read otherwise. --> +<!-- Paste any relevant logs and/or screenshots to help understanding the issue - please use code blocks (```) to format console output, logs, and code as it's tough to read otherwise. --> ### Possible fixes diff --git a/.gitlab/issue_templates/feature_request.md b/.gitlab/issue_templates/feature_request.md index 2055471..92a87e5 100644 --- a/.gitlab/issue_templates/feature_request.md +++ b/.gitlab/issue_templates/feature_request.md @@ -1,10 +1,20 @@ +<!--- +Please read this! + +Before opening a new issue, make sure to search for keywords in the issues filtered by the "feature_request" label: + +- https://gitlab.geant.org/marco.malavolti/eccs2/-/issues?label_name%5B%5D=feature_request + +and verify that the issue you're about to submit isn't a duplicate. +---> + ### Proposal -<!-- Use this section to explain the feature and how it will work. It can be helpful to add technical details, design proposals, and links to related epics or issues. --> +<!-- Use this section to explain the feature and how it will work. It can be helpful to add technical details, design proposals, and links to related issues. --> ### Relevant logs and/or screenshots -(Paste any relevant logs - please use code blocks (```) to format console output,logs, and code as it's very hard to read otherwise.) +(Paste any relevant logs and/or screenshots to help understanding proposal - please use code blocks (```) to format console output,logs, and code as it's very hard to read otherwise.) ### Possible fixes -- GitLab