Browse Source

Update ISSUE_TEMPLATE.md

Use comments and rephrase
Janek 3 years ago
parent
commit
021def818f
1 changed files with 23 additions and 25 deletions
  1. 23 25
      .github/ISSUE_TEMPLATE.md

+ 23 - 25
.github/ISSUE_TEMPLATE.md

@@ -1,37 +1,35 @@
 ## Issue
+<!--
+**[PLEASE UPGRADE](https://github.com/wekan/wekan/wiki/Backup)** to the newest WeKan ® before reporting an issue.
+Please search existing Open and Closed issues, most questions have already been answered.
 
-**[PLEASE UPGRADE](https://github.com/wekan/wekan/wiki/Backup)** to newest WeKan ® before adding new issue !!
-- We get too many duplicate reports of already fixed bugs. Newest WeKan ® has newest bugfixes and security fixes.
-- Please search existing Open and Closed issues, most questions have already been answered many times.
+If you can not login for any reason: https://github.com/wekan/wekan/wiki/Forgot-Password
+Email settings, only SMTP MAIL_URL and MAIL_FROM are in use: https://github.com/wekan/wekan/wiki/Troubleshooting-Mail
 
-If you can not login for any reason:
-- https://github.com/wekan/wekan/wiki/Forgot-Password
-
-Email settings, only SMTP MAIL_URL and MAIL_FROM are in use:
-- https://github.com/wekan/wekan/wiki/Troubleshooting-Mail
-
-Add these issues to elsewhere:
+The following types of issues should be reported separately:
 - SECURITY ISSUES: https://github.com/wekan/wekan/blob/master/SECURITY.md
 - UCS: https://github.com/wekan/univention/issues
+-->
 
-Other Wekan issues can be added here.
-
-**Server Setup Information**:
-
-* Note: Please anonymize info, and do not add to this public issue any of your Wekan board URLs, passwords, API tokens etc, do you understand?:
+### Server Setup Information
+<!-- Please anonymize info, and do not any of your Wekan board URLs, passwords, API tokens etc to this public issue. -->
 * Did you test in newest Wekan?:
-* For new Wekan install, did you configure root-url correctly so Wekan cards open correctly https://github.com/wekan/wekan/wiki/Settings ?
+* Did you configure root-url correctly so Wekan cards open correctly (see https://github.com/wekan/wekan/wiki/Settings)?
 * Operating System:
-* Deployment Method(Snap/Docker/Sandstorm/bundle/source):
+* Deployment Method (Snap/Docker/Sandstorm/bundle/source):
 * Http frontend if any (Caddy, Nginx, Apache, see config examples from Wekan GitHub wiki first):
 * Node.js Version:
 * MongoDB Version:
-* Wekan works on newest desktop and mobile webbrowsers that support Javascript. What webbrowser version are you using?
+* What webbrowser version are you using (Wekan should work on all modern browsers that support Javascript)?
+
+### Problem description
+<!-- Add a recorded animated gif (e.g. with https://github.com/phw/peek) about how it works currently, and screenshot mockups how it should work. -->
+#### Reproduction Steps
+
+#### Logs
+<!-- Check Right Click>Inspect>Console in you browser - generally Chrome shows more detailed info than Firefox. -->
 
-**Problem description**:
-- *REQUIRED: Add recorded animated gif about how it works currently, and screenshot mockups how it should work. Use peek to record animgif in Linux https://github.com/phw/peek*
-- *Explain steps how to reproduce*
-- *In webbrowser, what does show Right Click / Inspect / Console ? Chrome shows more detailed info than Firefox.*
-- *If using Snap, what does show command `sudo snap logs wekan.wekan` ? Please anonymize logs.* 
-- *If using Docker, what does show command `sudo docker logs wekan-app` ? Please anonymize logs.*
-- *If logs are very long, attach them in .zip file*
+<!-- Please anonymize logs.
+Snap: sudo snap logs wekan.wekan
+Docker: sudo docker logs wekan-app
+If logs are very long, attach them in .zip file -->