From: Mike Bayer <mike_mp@zzzcomputing.com>
Date: Sun, 9 May 2021 15:19:38 +0000 (-0400)
Subject: trying a different issue template
X-Git-Tag: rel_1_4_15~10
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=6e4952f8d171476a1d0390898010878b29b2ddff;p=thirdparty%2Fsqlalchemy%2Fsqlalchemy.git

trying a different issue template

Change-Id: Ibb4fda98f4fdef569ce0bb9435849f0009ff1a82
---

diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
index a0a229c824..d0aa228ac8 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -7,26 +7,49 @@ assignees: ''
 
 ---
 
+**GUIDELINES FOR REPORTING BUGS**
+
+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).   Each of these reports include the following features:
+
+1. a **succinct description of the problem** - typically a line or two at most
+2. As SQLAlchemy provides an intricate, fine-grained API around the concepts of
+   SQL, database connections, and object persistence, we very much need to
+   have **code to reproduce the problem**, otherwise known as
+   a [Minimal, Complete, and Verifiable](http://stackoverflow.com/help/mcve)
+   example.  This is code we can actually run, so that
+   we can understand the issue ourselves, as well as that you, the poster,
+   has isolated the issue from your own code.   This upfront effort to
+   isolate and demonstrate issues is essentially
+   **your contribution to the project**, we use these cases to create real
+   test cases, and we appreciate them very much!
+3. **complete stack traces for all errors** - error messages without context
+   are usually not enough information.  Often we can diagnose
+   complex issues just from a complete stack trace alone
+4. Other things as applicable:   **SQL log output**, see [logging](https://docs.sqlalchemy.org/en/14/core/engines.html#configuring-logging) for background on this, **database backend and DBAPI driver**,
+   **operating system**, **comparative performance timings** for
+   performance issues.
+
+
 **Describe the bug**
 <!-- A clear and concise description of what the bug is. -->
 
-**Expected behavior**
-<!-- A clear and concise description of what you expected to happen. -->
-
 **To Reproduce**
-Please try to provide a [Minimal, Complete, and Verifiable](http://stackoverflow.com/help/mcve) example.
-See also [Reporting Bugs](https://www.sqlalchemy.org/participate.html#bugs) on the website, and some [example issues](https://github.com/sqlalchemy/sqlalchemy/issues?q=label%3A%22great+mcve%22).
-
-**Please do not use Flask-SQLAlchemy or any other third-party extensions or dependencies in test cases**.  The test case must illustrate the problem **without** using any third party SQLAlchemy extensions.  Otherwise, please report the bug to those projects first.
+Provide your [Minimal, Complete, and Verifiable](http://stackoverflow.com/help/mcve) example
+here.
 
 ```py
 # Insert code here
 ```
 
 **Error**
+Provide the complete text of any errors received **including the complete
+stack trace**.   If the message is a warning, run your program with the
+``-Werror`` flag:   ``python -Werror myprogram.py``
 
 ```
-# Copy error here. Please include the full stack trace.
+# Copy complete stack trace and error message here, including SQL log output
+if applicable.
 ```
 
 **Versions.**