From d3faeff2b3de3fcd3733a4956904228b91be252e Mon Sep 17 00:00:00 2001 From: Mikey O'Toole Date: Wed, 30 Oct 2019 11:31:18 +0000 Subject: [PATCH 01/12] Create a GitLab general issue template I had a call with Craig this morning to discuss how to raise issues etc on GitLab for new contributors - it was useful but it made me realise that we can help out people opening issues with one or more sensible templates for issues to guide people on what information to include in their issue. So here's a general issue template based on the PR template and this issue of @jaapjansma's https://lab.civicrm.org/dev/core/issues/1345 --- .gitlab/issue_templates/general.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 .gitlab/issue_templates/general.md diff --git a/.gitlab/issue_templates/general.md b/.gitlab/issue_templates/general.md new file mode 100644 index 000000000000..3096e2bf3602 --- /dev/null +++ b/.gitlab/issue_templates/general.md @@ -0,0 +1,29 @@ +Overview: +---------------------------------------- +_Please describe your issue in detail._ + +Reproduction steps: +---------------------------------------- +1. Click on the thing. +2. Click on the other thing. +3. The thing exploded! + +Current behaviour: +---------------------------------------- +_What happens currently. Please provide screenshots or gifs ([LICEcap](http://www.cockos.com/licecap/), [SilentCast](https://github.com/colinkeenan/silentcast)) where appropriate._ + +Expected behaviour: +---------------------------------------- +_What should happen. Please provide screenshots or gifs ([LICEcap](http://www.cockos.com/licecap/), [SilentCast](https://github.com/colinkeenan/silentcast)) where appropriate._ + +Environment information: +---------------------------------------- + +* __Web Server:__ _Apache/LiteSpeed/Nginx/Other_ +* __CiviCRM Version:__ _Master_ +* __CMS:__ _Backdrop/Drupal/Joomla!/WordPress_ +* __Database:__ _MariaDB/MySQL/Percona/Other_ + +Comments +---------------------------------------- +_Anything else you would like the reviewer to note_ From 396d9dacb5b8e74f60fde9f7eb328310eec93ceb Mon Sep 17 00:00:00 2001 From: Mikey O'Toole Date: Thu, 31 Oct 2019 04:54:15 +0000 Subject: [PATCH 02/12] Update general.md --- .gitlab/issue_templates/general.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/.gitlab/issue_templates/general.md b/.gitlab/issue_templates/general.md index 3096e2bf3602..4850b3afe027 100644 --- a/.gitlab/issue_templates/general.md +++ b/.gitlab/issue_templates/general.md @@ -4,9 +4,11 @@ _Please describe your issue in detail._ Reproduction steps: ---------------------------------------- -1. Click on the thing. -2. Click on the other thing. -3. The thing exploded! +1. Click on **Contacts -> New Individual**. +1. Entered **First Name** and **Last Name** and clicked **Save**. +1. Got an error "**Fatal error: DB error**". + +````(Please include the full text of the error message. You can remove any private information like passwords. If you put it inside three backtick ` symbols it will wrap/format it nicely!)```` Current behaviour: ---------------------------------------- @@ -22,7 +24,9 @@ Environment information: * __Web Server:__ _Apache/LiteSpeed/Nginx/Other_ * __CiviCRM Version:__ _Master_ * __CMS:__ _Backdrop/Drupal/Joomla!/WordPress_ +* __CMS Version:__ _1.0_ * __Database:__ _MariaDB/MySQL/Percona/Other_ +* __Database Versions:__ _10.4_ Comments ---------------------------------------- From 6cbb83cd3a5700d3ad1104431949c5f5e0b3dd6f Mon Sep 17 00:00:00 2001 From: Mikey O'Toole Date: Thu, 31 Oct 2019 08:40:37 +0000 Subject: [PATCH 03/12] Update and rename general.md to general-bug-or-issue.md --- .../{general.md => general-bug-or-issue.md} | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) rename .gitlab/issue_templates/{general.md => general-bug-or-issue.md} (72%) diff --git a/.gitlab/issue_templates/general.md b/.gitlab/issue_templates/general-bug-or-issue.md similarity index 72% rename from .gitlab/issue_templates/general.md rename to .gitlab/issue_templates/general-bug-or-issue.md index 4850b3afe027..a38d056451fe 100644 --- a/.gitlab/issue_templates/general.md +++ b/.gitlab/issue_templates/general-bug-or-issue.md @@ -21,12 +21,15 @@ _What should happen. Please provide screenshots or gifs ([LICEcap](http://www.co Environment information: ---------------------------------------- -* __Web Server:__ _Apache/LiteSpeed/Nginx/Other_ -* __CiviCRM Version:__ _Master_ -* __CMS:__ _Backdrop/Drupal/Joomla!/WordPress_ -* __CMS Version:__ _1.0_ + + +* __Browser & Version:__ _Firefox 59.0.1/Chrome 78.0.3904/Safari 13_ +* __CiviCRM Version:__ _Master/5.20.0/5.19.1/5.18.2/..._ +* __CMS:__ _Backdrop/Drupal/Joomla/WordPress_ +* __CMS Version:__ _1.0/4.5/6.10/7.30/..._ * __Database:__ _MariaDB/MySQL/Percona/Other_ -* __Database Versions:__ _10.4_ +* __Database Versions:__ _5.5/5.7/10.3/10.4/..._ +* __Web Server:__ _Apache/LiteSpeed/Nginx/..._ Comments ---------------------------------------- From 57c007e26de0f7c187d9b08c1ecf730e89009443 Mon Sep 17 00:00:00 2001 From: Mikey O'Toole Date: Thu, 31 Oct 2019 08:41:19 +0000 Subject: [PATCH 04/12] Update general-bug-or-issue.md --- .gitlab/issue_templates/general-bug-or-issue.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.gitlab/issue_templates/general-bug-or-issue.md b/.gitlab/issue_templates/general-bug-or-issue.md index a38d056451fe..94fe5590c9f4 100644 --- a/.gitlab/issue_templates/general-bug-or-issue.md +++ b/.gitlab/issue_templates/general-bug-or-issue.md @@ -8,7 +8,7 @@ Reproduction steps: 1. Entered **First Name** and **Last Name** and clicked **Save**. 1. Got an error "**Fatal error: DB error**". -````(Please include the full text of the error message. You can remove any private information like passwords. If you put it inside three backtick ` symbols it will wrap/format it nicely!)```` +```(Please include the full text of the error message. You can remove any private information like passwords. If you put it inside three backtick ` symbols it will wrap/format it nicely!)``` Current behaviour: ---------------------------------------- From 8bf9974af70e33683459d0b672926ec7261700e3 Mon Sep 17 00:00:00 2001 From: Tim Otten Date: Wed, 6 Nov 2019 22:36:27 -0800 Subject: [PATCH 05/12] Issue template - Update "Environment"; combine type+version fields We want "versions" for everything. Making separate lines for the version just makes it bit harder to write (you have to remove more things) and to read (you have to skim more lines). Changes: * Combine "CMS/CMS Version" * Combine "Database/Database Version" * For "Web Server", also include version. * Add "PHP" --- .gitlab/issue_templates/general-bug-or-issue.md | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/.gitlab/issue_templates/general-bug-or-issue.md b/.gitlab/issue_templates/general-bug-or-issue.md index 94fe5590c9f4..bc2ecdde1458 100644 --- a/.gitlab/issue_templates/general-bug-or-issue.md +++ b/.gitlab/issue_templates/general-bug-or-issue.md @@ -23,13 +23,12 @@ Environment information: -* __Browser & Version:__ _Firefox 59.0.1/Chrome 78.0.3904/Safari 13_ -* __CiviCRM Version:__ _Master/5.20.0/5.19.1/5.18.2/..._ -* __CMS:__ _Backdrop/Drupal/Joomla/WordPress_ -* __CMS Version:__ _1.0/4.5/6.10/7.30/..._ -* __Database:__ _MariaDB/MySQL/Percona/Other_ -* __Database Versions:__ _5.5/5.7/10.3/10.4/..._ -* __Web Server:__ _Apache/LiteSpeed/Nginx/..._ +* __Browser:__ _Firefox 59.0.1/Chrome 78.0.3904/Safari 13_ +* __CiviCRM:__ _Master/5.20.0/5.19.1/5.18.2/..._ +* __PHP:__ _7.0/7.1/7.2/7.3/...__ +* __CMS:__ _Backdrop 1.5/Drupal 7.30/Joomla 3.3/WordPress 4.5/..._ +* __Database:__ _MySQL 5.7.7/MariaDB 10.4/..._ +* __Web Server:__ _Apache 2.4/Nginx 1.16/..._ Comments ---------------------------------------- From 01c05cde7f30ca244dd8afe689c845fcbbf754fe Mon Sep 17 00:00:00 2001 From: Tim Otten Date: Wed, 6 Nov 2019 22:40:55 -0800 Subject: [PATCH 06/12] Issue template - For triple `, use multiline --- .gitlab/issue_templates/general-bug-or-issue.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/.gitlab/issue_templates/general-bug-or-issue.md b/.gitlab/issue_templates/general-bug-or-issue.md index bc2ecdde1458..c1ce2c1bb9fb 100644 --- a/.gitlab/issue_templates/general-bug-or-issue.md +++ b/.gitlab/issue_templates/general-bug-or-issue.md @@ -8,7 +8,11 @@ Reproduction steps: 1. Entered **First Name** and **Last Name** and clicked **Save**. 1. Got an error "**Fatal error: DB error**". -```(Please include the full text of the error message. You can remove any private information like passwords. If you put it inside three backtick ` symbols it will wrap/format it nicely!)``` +``` +(Please include the full text of the error message. +You can remove any private information like passwords. +If you put it inside three backtick ` symbols it will wrap/format it nicely!) +``` Current behaviour: ---------------------------------------- From cafc5524ff34b881d58af923dd1899dc4692425e Mon Sep 17 00:00:00 2001 From: Tim Otten Date: Wed, 6 Nov 2019 22:44:04 -0800 Subject: [PATCH 07/12] Issue template - No screenshot for expected behavior The "Expected Behavior" is specifically what the system does *not* do, so... it might be hard to give a screenshot of that... --- .gitlab/issue_templates/general-bug-or-issue.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.gitlab/issue_templates/general-bug-or-issue.md b/.gitlab/issue_templates/general-bug-or-issue.md index c1ce2c1bb9fb..d94d971e8110 100644 --- a/.gitlab/issue_templates/general-bug-or-issue.md +++ b/.gitlab/issue_templates/general-bug-or-issue.md @@ -20,7 +20,7 @@ _What happens currently. Please provide screenshots or gifs ([LICEcap](http://ww Expected behaviour: ---------------------------------------- -_What should happen. Please provide screenshots or gifs ([LICEcap](http://www.cockos.com/licecap/), [SilentCast](https://github.com/colinkeenan/silentcast)) where appropriate._ +_What should happen._ Environment information: ---------------------------------------- From f0ee3c91f2fa05a734365d092acff750af4eabc0 Mon Sep 17 00:00:00 2001 From: Tim Otten Date: Wed, 6 Nov 2019 22:57:22 -0800 Subject: [PATCH 08/12] Issue template - Move error-msg block from "Reproduction steps" to "Current behavior" --- .gitlab/issue_templates/general-bug-or-issue.md | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/.gitlab/issue_templates/general-bug-or-issue.md b/.gitlab/issue_templates/general-bug-or-issue.md index d94d971e8110..1a45379d301f 100644 --- a/.gitlab/issue_templates/general-bug-or-issue.md +++ b/.gitlab/issue_templates/general-bug-or-issue.md @@ -8,15 +8,16 @@ Reproduction steps: 1. Entered **First Name** and **Last Name** and clicked **Save**. 1. Got an error "**Fatal error: DB error**". -``` -(Please include the full text of the error message. -You can remove any private information like passwords. -If you put it inside three backtick ` symbols it will wrap/format it nicely!) -``` - Current behaviour: ---------------------------------------- -_What happens currently. Please provide screenshots or gifs ([LICEcap](http://www.cockos.com/licecap/), [SilentCast](https://github.com/colinkeenan/silentcast)) where appropriate._ +_What happens currently. Please provide error messages, screenshots or gifs ([LICEcap](http://www.cockos.com/licecap/), [SilentCast](https://github.com/colinkeenan/silentcast)) where appropriate._ + +``` +TIP: The best way to convey an error message is to copy it in here and use +three backtick ` symbols. You may edit the message to remove private +information (like passwords). The backticks will help to preserve any +special characters or spaces. +``` Expected behaviour: ---------------------------------------- From 8207d1a1ff138a2e6f66105e2f15973ce4ad0c62 Mon Sep 17 00:00:00 2001 From: Tim Otten Date: Wed, 6 Nov 2019 23:01:32 -0800 Subject: [PATCH 09/12] Issue template - Rename "general-bug-or-issue" to "problem" Because... fewer words --- .gitlab/issue_templates/{general-bug-or-issue.md => problem.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename .gitlab/issue_templates/{general-bug-or-issue.md => problem.md} (100%) diff --git a/.gitlab/issue_templates/general-bug-or-issue.md b/.gitlab/issue_templates/problem.md similarity index 100% rename from .gitlab/issue_templates/general-bug-or-issue.md rename to .gitlab/issue_templates/problem.md From 72ec9a567ab74eab4f5689fa42e67612ea77f78c Mon Sep 17 00:00:00 2001 From: Tim Otten Date: Wed, 6 Nov 2019 23:15:27 -0800 Subject: [PATCH 10/12] Issue template - Small tweak --- .gitlab/issue_templates/problem.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.gitlab/issue_templates/problem.md b/.gitlab/issue_templates/problem.md index 1a45379d301f..2566a514f414 100644 --- a/.gitlab/issue_templates/problem.md +++ b/.gitlab/issue_templates/problem.md @@ -1,6 +1,6 @@ Overview: ---------------------------------------- -_Please describe your issue in detail._ +_Please describe your problem or bug in detail._ Reproduction steps: ---------------------------------------- From 1505325c56fd80648acbfa5c8bd3a77a81a6802e Mon Sep 17 00:00:00 2001 From: Tim Otten Date: Wed, 6 Nov 2019 23:20:26 -0800 Subject: [PATCH 11/12] Issue template - More consistent punctuation * End comment-placeholder with period, like in other comment-placeholders * Remove colons from titles - don't think we do that anywhere else --- .gitlab/issue_templates/problem.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/.gitlab/issue_templates/problem.md b/.gitlab/issue_templates/problem.md index 2566a514f414..6e911e9a05f7 100644 --- a/.gitlab/issue_templates/problem.md +++ b/.gitlab/issue_templates/problem.md @@ -1,14 +1,14 @@ -Overview: +Overview ---------------------------------------- _Please describe your problem or bug in detail._ -Reproduction steps: +Reproduction steps ---------------------------------------- 1. Click on **Contacts -> New Individual**. 1. Entered **First Name** and **Last Name** and clicked **Save**. 1. Got an error "**Fatal error: DB error**". -Current behaviour: +Current behaviour ---------------------------------------- _What happens currently. Please provide error messages, screenshots or gifs ([LICEcap](http://www.cockos.com/licecap/), [SilentCast](https://github.com/colinkeenan/silentcast)) where appropriate._ @@ -19,11 +19,11 @@ information (like passwords). The backticks will help to preserve any special characters or spaces. ``` -Expected behaviour: +Expected behaviour ---------------------------------------- _What should happen._ -Environment information: +Environment information ---------------------------------------- @@ -37,4 +37,4 @@ Environment information: Comments ---------------------------------------- -_Anything else you would like the reviewer to note_ +_Anything else you would like the reviewer to note._ From 754f3f547e5f518c66ca56e4d6ad55f6de5bfff9 Mon Sep 17 00:00:00 2001 From: Tim Otten Date: Wed, 6 Nov 2019 23:23:03 -0800 Subject: [PATCH 12/12] Issue template - Add "improvement.md" This is basically the same as the bug-report template, except: * "Reproduction steps" become "Example use-case" * "Environment" is removed - because it's not usually a factor. (And if it is, it's generally explicit part of the requirements.) --- .gitlab/issue_templates/improvement.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 .gitlab/issue_templates/improvement.md diff --git a/.gitlab/issue_templates/improvement.md b/.gitlab/issue_templates/improvement.md new file mode 100644 index 000000000000..3f8e98a76667 --- /dev/null +++ b/.gitlab/issue_templates/improvement.md @@ -0,0 +1,20 @@ +Overview +---------------------------------------- +_Please describe your improvement in detail._ + +Example use-case +---------------------------------------- +1. Click on **Contacts -> New Individual**. +1. Enter **First Name** and **Last Name** and click **Save**. + +Current behaviour +---------------------------------------- +_What is currently possible? What limit ?_ + +Proposed behaviour +---------------------------------------- +_What should happen? How is this better? If appropriate/available, include any wireframes or mockups._ + +Comments +---------------------------------------- +_Anything else you would like the reviewer to note._