Browse Source

Merge pull request #1447 from jjlin/issue-templates

Allow only bug report issues
Mathijs van Veluw 4 years ago
parent
commit
ebe334fcc7

+ 37 - 22
.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,51 +1,66 @@
 ---
 ---
 name: Bug report
 name: Bug report
-about: Create a report to help us improve
+about: Use this ONLY for bugs in bitwarden_rs itself. Use the Discourse forum (link below) to request features or get help with usage/configuration. If in doubt, use the forum.
 title: ''
 title: ''
 labels: ''
 labels: ''
 assignees: ''
 assignees: ''
 
 
 ---
 ---
 <!--
 <!--
-     # ###
-     NOTE: Please update to the latest version of bitwarden_rs before reporting an issue!
-     This saves you and us a lot of time and troubleshooting.
-     See: https://github.com/dani-garcia/bitwarden_rs/issues/1180
-     # ###
+    # ###
+    NOTE: Please update to the latest version of bitwarden_rs before reporting an issue!
+    This saves you and us a lot of time and troubleshooting.
+    See:
+    * https://github.com/dani-garcia/bitwarden_rs/issues/1180
+    * https://github.com/dani-garcia/bitwarden_rs/wiki/Updating-the-bitwarden-image
+    # ###
 -->
 -->
 
 
-
 <!--
 <!--
 Please fill out the following template to make solving your problem easier and faster for us.
 Please fill out the following template to make solving your problem easier and faster for us.
 This is only a guideline. If you think that parts are unnecessary for your issue, feel free to remove them.
 This is only a guideline. If you think that parts are unnecessary for your issue, feel free to remove them.
 
 
-Remember to hide/obfuscate personal and confidential information,
-such as names, global IP/DNS addresses and especially passwords, if necessary.
+Remember to hide/redact personal or confidential information,
+such as passwords, IP addresses, and DNS names as appropriate.
 -->
 -->
 
 
 ### Subject of the issue
 ### Subject of the issue
-<!-- Describe your issue here.-->
+<!-- Describe your issue here. -->
+
+### Deployment environment
+
+<!--
+    =========================================================================================
+    Preferably, use the `Generate Support String` button on the admin page's Diagnostics tab.
+    That will auto-generate most of the info requested in this section.
+    =========================================================================================
+-->
 
 
-### Your environment
-<!-- The version number, obtained from the logs or the admin diagnostics page -->
-<!-- Remember to check your issue on the latest version first! -->
-* Bitwarden_rs version:
-<!-- How the server was installed: Docker image / package / built from source -->
+<!-- The version number, obtained from the logs (at startup) or the admin diagnostics page -->
+<!-- This is NOT the version number shown on the web vault, which is versioned separately from bitwarden_rs -->
+<!-- Remember to check if your issue exists on the latest version first! -->
+* bitwarden_rs version:
+
+<!-- How the server was installed: Docker image, OS package, built from source, etc. -->
 * Install method:
 * Install method:
-* Clients used: <!-- if applicable -->
+
+* Clients used: <!-- web vault, desktop, Android, iOS, etc. (if applicable) -->
+
 * Reverse proxy and version: <!-- if applicable -->
 * Reverse proxy and version: <!-- if applicable -->
-* Version of mysql/postgresql: <!-- if applicable -->
-* Other relevant information:
+
+* MySQL/MariaDB or PostgreSQL version: <!-- if applicable -->
+
+* Other relevant details:
 
 
 ### Steps to reproduce
 ### Steps to reproduce
 <!-- Tell us how to reproduce this issue. What parameters did you set (differently from the defaults)
 <!-- Tell us how to reproduce this issue. What parameters did you set (differently from the defaults)
 and how did you start bitwarden_rs? -->
 and how did you start bitwarden_rs? -->
 
 
 ### Expected behaviour
 ### Expected behaviour
-<!-- Tell us what should happen -->
+<!-- Tell us what you expected to happen -->
 
 
 ### Actual behaviour
 ### Actual behaviour
-<!-- Tell us what happens instead -->
+<!-- Tell us what actually happened -->
 
 
-### Relevant logs
-<!-- Share some logfiles, screenshots or output of relevant programs with us. -->
+### Troubleshooting data
+<!-- Share any log files, screenshots, or other relevant troubleshooting data -->

+ 8 - 0
.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,8 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Discourse forum for bitwarden_rs
+    url: https://bitwardenrs.discourse.group/
+    about: Use this forum to request features or get help with usage/configuration.
+  - name: GitHub Discussions for bitwarden_rs
+    url: https://github.com/dani-garcia/bitwarden_rs/discussions
+    about: An alternative to the Discourse forum, if this is easier for you.

+ 0 - 11
.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,11 +0,0 @@
----
-name: Feature request
-about: Suggest an idea for this project
-title: ''
-labels: better for forum
-assignees: ''
-
----
-
-# Please submit all your feature requests to the forum
-Link: https://bitwardenrs.discourse.group/c/feature-requests

+ 0 - 11
.github/ISSUE_TEMPLATE/help-with-installation-configuration.md

@@ -1,11 +0,0 @@
----
-name: Help with installation/configuration
-about: Any questions about the setup of bitwarden_rs
-title: ''
-labels: better for forum
-assignees: ''
-
----
-
-# Please submit all your third party help requests to the forum
-Link: https://bitwardenrs.discourse.group/c/help

+ 0 - 11
.github/ISSUE_TEMPLATE/help-with-proxy-database-nas-setup.md

@@ -1,11 +0,0 @@
----
-name: Help with proxy/database/NAS setup
-about: Any questions about third party software
-title: ''
-labels: better for forum
-assignees: ''
-
----
-
-# Please submit all your third party help requests to the forum
-Link: https://bitwardenrs.discourse.group/c/third-party-help