summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMike Bayer <mike_mp@zzzcomputing.com>2021-05-09 11:54:15 -0400
committerMike Bayer <mike_mp@zzzcomputing.com>2021-05-09 11:54:15 -0400
commit334b83643e6f64eadcdff8b2ab0f072ccc6d3abe (patch)
tree840e964d1ca8462d2936909453b82ae8b282aa51
parent17e85e3e8f8269ccca45a2d2ac2aeb8ec4249d95 (diff)
downloadsqlalchemy-334b83643e6f64eadcdff8b2ab0f072ccc6d3abe.tar.gz
remove extra verbiage
having all this verbiage in the template itself means all the issues will have all this verbiage in them, so pull it back again. there is unfortunately no way to cleanly direct reporters through the guidelines with github. Change-Id: I9835e412fac244b639d1fe6970e4dab43ab95117
-rw-r--r--.github/ISSUE_TEMPLATE/bug_report.md20
1 files changed, 5 insertions, 15 deletions
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
index ad4b34300..6c8c8052b 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -13,22 +13,12 @@ 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:
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
+2. **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.
+ example.
+3. **complete stack traces for all errors**
+4. Other things as applicable: **SQL log output**, **database backend and DBAPI driver**,
+ **operating system**, **comparative performance timings** for performance issues.
**Describe the bug**