From: Mike Bayer <mike_mp@zzzcomputing.com>
Date: Tue, 7 Feb 2023 18:21:37 +0000 (-0500)
Subject: issue template updates
X-Git-Tag: rel_2_0_3~12
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=509dadd5cd90fd719d13f6e6dfe3cf94f081292a;p=thirdparty%2Fsqlalchemy%2Fsqlalchemy.git

issue template updates

forgive me, I'm just live editing, will test immediately

Change-Id: I404edac799222aea615886c5e821d7433b8f2e7a
---

diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml
index ee2fc54593..71c9993fe6 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.yaml
+++ b/.github/ISSUE_TEMPLATE/bug_report.yaml
@@ -9,28 +9,21 @@ body:
     attributes:
       value: "
 
-**FOR ALL USERS - PLEASE READ THIS PARAGRAPH AS IT IS HELPS US TO DO OUR WORK MORE EFFICIENTLY:**
-
-The **VAST MAJORITY** of bugs reported are in fact
-**USAGE QUESTIONS, NOT BUGS** for APIs that can take some practice to familiarize with,
-and which are also tailored towards high quality relational designs that
-beginners are sometimes less familiar with.
-
-If you are relatively new to SQLAlchemy, and even if not but the issue is uncertain, PLEASE START A NEW
-[DISCUSSION](https://github.com/sqlalchemy/sqlalchemy/discussions/new?category=Usage-Questions) INSTEAD, so that we can
-help with your issue.   If you are relatively new to
-SQLAlchemy, there is an approximately **90% chance your issue is not a bug and will be converted to a
-discussion in any case**.
-If your issue is actually a bug, we will open a new bug report with what we need.
+**If you are writing new SQLAlchemy code and are observing a behavior that you did not expect,
+or if you are new to SQLAlchemy overall, please open a
+[discussion](https://github.com/sqlalchemy/sqlalchemy/discussions/new?category=Usage-Questions)
+instead of an issue report.  The vast majority of new issues are converted to discussions**
 
 [START A NEW USAGE QUESTIONS DISCUSSION HERE](https://github.com/sqlalchemy/sqlalchemy/discussions/new?category=Usage-Questions)
 
 "
   - type: markdown
     attributes:
-      value: "**IF YOUR ISSUE RELATES TO AN @ SIGN, OR ANY OTHER NON-ALPHANUMERIC CHARACTER IN YOUR PASSWORD.  THIS IS NOT A BUG.**
+      value: "**If your issue is you have upgraded SQLAlchemy and now can't connect to the database, please READ THIS FIRST:**
+
+URL escape **@ signs and any other non-alphanumeric characters** in passwords;  **@ signs
+must be escaped in modern versions of SQLAlchemy which was not the case with older versions**.
 
-Please URL escape **@ signs and any other non-alphanumeric characters** in passwords;
 For the ``@`` sign for example, the escape is `%40`.
 See [Engine URLs](https://docs.sqlalchemy.org/en/stable/core/engines.html#escaping-special-characters-such-as-signs-in-passwords)
     "
@@ -40,6 +33,12 @@ See [Engine URLs](https://docs.sqlalchemy.org/en/stable/core/engines.html#escapi
 
 **GUIDELINES FOR REPORTING BUGS**
 
+IF YOU DO NOT HAVE A COMPLETE, RUNNABLE TEST CASE WRITTEN DIRECTLY IN THE TEXTAREA BELOW,
+YOUR ISSUE WILL BE CLOSED.   PLEASE OPEN A
+[DISCUSSION](https://github.com/sqlalchemy/sqlalchemy/discussions/new?category=Usage-Questions)
+IF YOU DON'T HAVE A COMPLETE TEST CASE!
+
+
 If you are new to SQLAlchemy bug reports, please review our many examples
 of [well written bug reports](https://github.com/sqlalchemy/sqlalchemy/issues?q=is%3Aissue+label%3A%22great+mcve%22).   Each of these reports include the following features:
 
@@ -89,15 +88,35 @@ If the message is a warning, run your program with the ``-Werror`` flag:   ``pyt
     validations:
       required: true
 
-  - type: textarea
+  - type: input
+    id: sqlaversion
+    attributes:
+      label: SQLAlchemy Version in Use
+      description: the full version of SQLAlchemy in use
+    validations:
+      required: true
+
+  - type: input
+    id: dbapiversion
+    attributes:
+      label: DBAPI Version
+      description: the DBAPI (database driver) version
+    validations:
+      required: true
+
+  - type: input
+    id: database
+    attributes:
+      label: Database Vendor and Version
+      description: e.g. SQLite, PostgreSQL 12, MariaDB 8
+    validations:
+      required: true
+
+  - type: input
+    id: os
     attributes:
-      label: Versions
-      value: |
-        - OS:
-        - Python:
-        - SQLAlchemy:
-        - Database:
-        - DBAPI (eg: psycopg, cx_oracle, mysqlclient):
+      label: Operating system
+      description: Linux, Windows, OSX
     validations:
       required: true