From 709c0d3e8b2a5b9633759788a1b55b8254f87dfb Mon Sep 17 00:00:00 2001 From: Mike Bayer Date: Sun, 16 May 2021 12:45:59 -0400 Subject: [PATCH] rework issue template only bug reports are encouraged through "issues" all other questions / features go through discussions links to external help resources Change-Id: I6ac2dc460a3bf9fbdaf63c1269e9ba7a5501f181 --- .github/ISSUE_TEMPLATE/bug_report.md | 6 ++-- .github/ISSUE_TEMPLATE/feature_request.md | 22 --------------- .github/ISSUE_TEMPLATE/question.md | 34 ----------------------- 3 files changed, 3 insertions(+), 59 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md delete mode 100644 .github/ISSUE_TEMPLATE/question.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index f7e4fad364..87c3aeffe3 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,6 +1,6 @@ --- -name: Bug report -about: Create a report to help us improve +name: Create a bug report +about: Errors and regression reports with complete reproducing test cases and/or stack traces. title: '' labels: requires triage assignees: '' @@ -14,7 +14,7 @@ of [well written bug reports](https://github.com/sqlalchemy/sqlalchemy/issues?q= 1. a **succinct description of the problem** - typically a line or two at most 2. **succinct, dependency-free code which reproduces the problem**, otherwise known as a [Minimal, Complete, and Verifiable](http://stackoverflow.com/help/mcve) example. -3. **complete stack traces for all errors** +3. **complete stack traces for all errors - please avoid screenshots, use formatted text inside issues** 4. Other things as applicable: **SQL log output**, **database backend and DBAPI driver**, **operating system**, **comparative performance timings** for performance issues. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 818bd38a54..0000000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: '' -labels: requires triage -assignees: '' - ---- - -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] - -**Describe the solution you'd like** -A clear and concise description of what you want to happen. - -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. - -**Additional context** -Add any other context or screenshots about the feature request here. - -**Have a nice day!** diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md deleted file mode 100644 index 2591f40b03..0000000000 --- a/.github/ISSUE_TEMPLATE/question.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -name: Question -about: Question regarding SQLAlchemy features -title: '' -labels: requires triage -assignees: '' - ---- - -**Describe your question** - -**Example - please use the [Minimal, Complete, and Verifiable](http://stackoverflow.com/help/mcve) guidelines if possible** - -**Complete stack trace, if applicable** - -**Versions** - - OS: - - Python: - - SQLAlchemy: - - Database: - - DBAPI: - -**Additional context** -Add any other context or screenshots about the feature request here. - -**Useful links** -- [Get Support](https://www.sqlalchemy.org/support.html) on the website -- The [documentation](https://docs.sqlalchemy.org/en/latest/) website -- The [UsageRecipes](https://github.com/sqlalchemy/sqlalchemy/wiki/UsageRecipes) wiki -- [Stack Overflow](https://stackoverflow.com/questions/tagged/sqlalchemy) tag -- SQLAlchemy [Google group](http://groups.google.com/group/sqlalchemy) -- [Gitter](https://gitter.im/sqlalchemy/community) chat - -**Have a nice day!** -- 2.47.3