From 51cc5a53a1e4c9bfb778fcd23d0d40cd8474c5ce Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jo=C3=A3o=20Valverde?= Date: Fri, 21 Apr 2023 15:59:37 +0100 Subject: [PATCH] Gitlab templates: Be more forceful asking for a capture Reproducer captures are essential for developers. Move the request to the top of the template and be more forceful stressing the importance of capture files to fix bugs and implement feature requests. --- .gitlab/issue_templates/Bug.md | 25 ++++++++--------------- .gitlab/issue_templates/FeatureRequest.md | 17 ++++++++------- 2 files changed, 19 insertions(+), 23 deletions(-) diff --git a/.gitlab/issue_templates/Bug.md b/.gitlab/issue_templates/Bug.md index 79218afcc3..c10b77631c 100644 --- a/.gitlab/issue_templates/Bug.md +++ b/.gitlab/issue_templates/Bug.md @@ -2,34 +2,27 @@ (Summarize the bug encountered concisely) +## Sample capture file + +(For non-trivial issues a capture file is essential to reproduce and fix the bug. +Screenshots are not enough) + +(You can attach a capture file using the paper clip button in the editor menu bar. +Ensure your capture file does not contain private or sensitive information that cannot +be shared publicly) ## Steps to reproduce (How one can reproduce the issue - this is very important) - ## What is the current bug behavior? -(What actually happens) - +(What actually happens. Include detailed information like logs and screenshots if possible) ## What is the expected correct behavior? (What you should see instead) - -## Sample capture file - -(If possible attach a sample capture file, not screenshot of dissection, showing this issue. - You can do so by using the paper clip button in the editor menu bar.) - - -## Relevant logs and/or screenshots -``` -(Paste any relevant logs here) -``` -(Paste any relevant screenshots here) - ## Build information ``` (In Wireshark, select Help->About Wireshark from the main menu and use the button "Copy To Clipboard". diff --git a/.gitlab/issue_templates/FeatureRequest.md b/.gitlab/issue_templates/FeatureRequest.md index 09472ac038..bb0b13d05a 100644 --- a/.gitlab/issue_templates/FeatureRequest.md +++ b/.gitlab/issue_templates/FeatureRequest.md @@ -2,16 +2,19 @@ (Description including problem, use cases, benefits, and/or goals) +## Sample capture file + +(For non-trivial enhancements attaching a sample capture that can be used +to test the new feature (before and after) is extremely useful and will greatly +increase the chances that the enhancement will be implemented in the future) + +(You can attach a capture file using the paper clip button in the editor menu bar. +Ensure your capture file does not contain private or sensitive information that cannot +be shared publicly) ## Links / references / protocol specifications -(URLs to publically accessible websites, or other references) - - -## Sample capture - -(For dissector enhancements please attach a sample capture) - +(URLs to publicly accessible websites, or other references) ~enhancement /label ~enhancement