From ce462630f151367a1ad12e51826d92f0404f0833 Mon Sep 17 00:00:00 2001 From: Michael Gratton Date: Fri, 5 Jul 2019 12:47:29 +1000 Subject: [PATCH] Update Gitlab issue templates Refer to problem report dialog and the inspector as a source of information and take some suggestions from !56. --- .gitlab/issue_templates/New bug.md | 59 ++++++++++++++++---------- .gitlab/issue_templates/New feature.md | 30 +++++++------ 2 files changed, 55 insertions(+), 34 deletions(-) diff --git a/.gitlab/issue_templates/New bug.md b/.gitlab/issue_templates/New bug.md index 6885572f..ae93ac5f 100644 --- a/.gitlab/issue_templates/New bug.md +++ b/.gitlab/issue_templates/New bug.md @@ -1,36 +1,51 @@ -**Bug summary** +**Bug Summary** -(Summarise the bug encountered concisely here. Please replace all text -in parentheses like these.) +Provide a short summary of the bug you encountered. Please replace all +comments such as this with the requested information. -**About you** - * Geary version: (x.y.z) - * Installation method: (Package? Flathub? Source code?) - * Your desktop: (GNOME? KDE? Something else?) - * Your operating system and version: (Ubuntu 16.04? Fedora 28? Rolled your own?) - * Email provider: (Gmail, Yahoo!, Outlook.com, or someone else?) +**Your installation** + +To obtain installation information, copy it from Geary's Problem +Report dialog if shown (or else open the Geary Inspector by typing +Shift + Alt + I) by selecting System, and clicking the Copy +button, then pasting here. + + * Geary version: + * Installation method: + * Desktop environment: + * Operating system and version: + * Email provider: + **Steps to reproduce** - 1. (Step one) - 2. (Step two) - 3. (...) + 1. Step one + 2. Step two + 3. ... -**What is the current bug behavior?** -(What actually happens) +**What happened?** -**What is the expected correct behavior?** +What did Geary do that was unexpected? + + +**What did you expect to happen?** + +What did you expect Geary to do? -(What you see happening instead) **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. If -the bug is a crash, please obtain a [stack -trace](https://wiki.gnome.org/Apps/Geary/ReportingABug#Stack_Trace) -and attach it to this bug.) +To obtain log information, save it from Geary's Problem Report dialog +if shown (or else open the Geary Inspector by typing Shift + Alt + I), +by clicking the Save As button and attaching the resulting file +to this issue. -/label ~Bug +If the bug is a crash, please obtain a stack trace and attach it to +this issue so it can be debugged by following the instructions on this +page: https://wiki.gnome.org/Apps/Geary/ReportingABug#Stack_Trace + + + +/label ~"1. Bug" diff --git a/.gitlab/issue_templates/New feature.md b/.gitlab/issue_templates/New feature.md index 55643fd6..d6531447 100644 --- a/.gitlab/issue_templates/New feature.md +++ b/.gitlab/issue_templates/New feature.md @@ -1,18 +1,24 @@ -**Feature summary** +**Feature Summary** -(Describe what you would like to be able to do with Geary that you -currently cannot do, such as "send email whilst underwater". Please -replace all text in parentheses like these.) +Describe what you would like to be able to do with Geary that you +currently cannot do, such as "send email whilst underwater". -**How would you like it to work?** +Please replace all comments such as this with the requested +information. -(If you can think of a way Geary might be able to do this, let us know -here.) -**Relevant links, screenshots, etc** +**How would you like it to work** -(If you have further information about the missing feature such as -technical documentation or a similar feature in another email -application, please provide links and/or screenshots.) +If you can think of a way Geary might be able to do this, let us know +here. -/label ~Feature + +**Relevant links, screenshots, etc.** + +If you have further information about missing features, such as +technical documentation, or a similar feature in another email +application, please provide links and/or screenshots. + + + +/label ~"1. Feature"