From 8b0e2edc52f294cf58a8624b31f0ce630c8069dd Mon Sep 17 00:00:00 2001 From: Dimitri Huisman <52963853+Diman0@users.noreply.github.com> Date: Mon, 7 Sep 2020 17:19:53 +0200 Subject: [PATCH 1/3] Create ISSUE_TEMPLATE.md Add bug template to be used for reporting issues. --- ISSUE_TEMPLATE.md | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 ISSUE_TEMPLATE.md diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md new file mode 100644 index 00000000..0e4ce0bd --- /dev/null +++ b/ISSUE_TEMPLATE.md @@ -0,0 +1,36 @@ +Thank you for opening an issue with Mailu. Please understand that issues are meant for bugs and enhancement-requests. +For **user-support questions**, reach out to us on [matrix](https://matrix.to/#/#mailu:tedomum.net). + +To be able to help you best, we need some more information. + +## Before you open your issue +- [ ] Check if no issue or pull-request for this already exists. +- [ ] Check [documentation](https://mailu.io/master/) and [FAQ](https://mailu.io/master/faq.html). (Tip, use the search function on the documentation page) +- [ ] You understand `Mailu` is made by volunteers in their **free time** — be conscise, civil and accept that delays can occur. +- [ ] The title of the issue should be short and simple. It should contain specific terms related to the actual issue. Be specific while writing the title. + +## Environment & Versions +Environment: + - [ ] docker-compose + - [ ] kubernetes + - [ ] docker swarm + +Versions: +To find your version, get the image name of a mailu container and read the version from the tag (example for version 1.7). +`docker ps -a | grep mailu` +`140b09d4b09c mailu/roundcube:1.7 "docker-php-entrypoi…" 2 weeks ago Up 2 days (healthy) 80/tcp` + +## Description + + +## Replication Steps +< Steps for replicating your issue> + +## Expected behaviour + + + +## Logs +Often it is very useful to include log fragments of the involded component. You can get the logs via `docker logs --tail 1000`. For example for the admin container: +`docker logs mailu_admin_1 --tail 1000` +or using docker-compose `docker-compose -f /mailu/docker-compose.yml logs --tail 1000 admin` From 2e574d7ffbe5451b1f3e6488cf0992e19969eed1 Mon Sep 17 00:00:00 2001 From: Dario Ernst Date: Fri, 11 Sep 2020 22:39:21 +0200 Subject: [PATCH 2/3] Fix issue-template whitespacing; Add some small formatting --- ISSUE_TEMPLATE.md | 28 ++++++++++++++++++---------- 1 file changed, 18 insertions(+), 10 deletions(-) diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md index 0e4ce0bd..28983d8f 100644 --- a/ISSUE_TEMPLATE.md +++ b/ISSUE_TEMPLATE.md @@ -1,4 +1,4 @@ -Thank you for opening an issue with Mailu. Please understand that issues are meant for bugs and enhancement-requests. +Thank you for opening an issue with Mailu. Please understand that issues are meant for bugs and enhancement-requests. For **user-support questions**, reach out to us on [matrix](https://matrix.to/#/#mailu:tedomum.net). To be able to help you best, we need some more information. @@ -16,21 +16,29 @@ Environment: - [ ] docker swarm Versions: -To find your version, get the image name of a mailu container and read the version from the tag (example for version 1.7). -`docker ps -a | grep mailu` -`140b09d4b09c mailu/roundcube:1.7 "docker-php-entrypoi…" 2 weeks ago Up 2 days (healthy) 80/tcp` +To find your version, get the image name of a mailu container and read the version from the tag (example for version 1.7). +``` +$> docker ps -a | grep mailu +140b09d4b09c mailu/roundcube:1.7 "docker-php-entrypoi…" 2 weeks ago Up 2 days (healthy) 80/tcp +$> grep MAILU_VERSION docker-compose.yml mailu.env +``` ## Description ## Replication Steps -< Steps for replicating your issue> + ## Expected behaviour - - - + + ## Logs -Often it is very useful to include log fragments of the involded component. You can get the logs via `docker logs --tail 1000`. For example for the admin container: -`docker logs mailu_admin_1 --tail 1000` +Often it is very useful to include log fragments of the involved component. You can get the logs via `docker logs --tail 1000`. For example for the admin container: +`docker logs mailu_admin_1 --tail 1000` or using docker-compose `docker-compose -f /mailu/docker-compose.yml logs --tail 1000 admin` +If you can find the relevant section, please share only the parts that seem relevant. If you have any logs, please enclose them in code tags, like so: +````markdown +``` +Your logs here! +``` +```` From f3313fa26c36c37a9e87240cbdaf69359ea43cc7 Mon Sep 17 00:00:00 2001 From: Dario Ernst Date: Fri, 11 Sep 2020 22:44:21 +0200 Subject: [PATCH 3/3] Remove <> tags as they break markdown rendering --- ISSUE_TEMPLATE.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md index 28983d8f..10b9134f 100644 --- a/ISSUE_TEMPLATE.md +++ b/ISSUE_TEMPLATE.md @@ -10,12 +10,12 @@ To be able to help you best, we need some more information. - [ ] The title of the issue should be short and simple. It should contain specific terms related to the actual issue. Be specific while writing the title. ## Environment & Versions -Environment: +### Environment - [ ] docker-compose - [ ] kubernetes - [ ] docker swarm -Versions: +### Versions To find your version, get the image name of a mailu container and read the version from the tag (example for version 1.7). ``` $> docker ps -a | grep mailu @@ -24,13 +24,13 @@ $> grep MAILU_VERSION docker-compose.yml mailu.env ``` ## Description - +Further explain the bug in a few words. It should be clear what the unexpected behaviour is. Share it in an easy-to-understand language. ## Replication Steps - +Steps for replicating your issue ## Expected behaviour - +Explain what results you expected - be as specific as possible. Just saying "it doesn’t work as expected" is not useful. It's also helpful to describe what you actually experienced. ## Logs Often it is very useful to include log fragments of the involved component. You can get the logs via `docker logs --tail 1000`. For example for the admin container: