From 4496437eae40adda18dba8e66cef5e18e6abf081 Mon Sep 17 00:00:00 2001 From: Federico Caselli Date: Fri, 23 Jul 2021 23:35:54 +0200 Subject: [PATCH] replace bug_report issue template with issue form Change-Id: Ibc19b893c9930b563e13455652f7293317d64fd4 --- .github/ISSUE_TEMPLATE/bug_report.md | 56 ------------------- .github/ISSUE_TEMPLATE/bug_report.yaml | 75 ++++++++++++++++++++++++++ 2 files changed, 75 insertions(+), 56 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yaml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index f923281fad..0000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -name: Create a bug report -about: Errors and regression reports with complete reproducing test cases and/or stack traces. -title: '' -labels: requires triage -assignees: '' - ---- - - - -**Describe the bug** - - -**To Reproduce** -Provide your [Minimal, Complete, and Verifiable](https://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 complete stack trace and error message here, including SQL log output -if applicable. -``` - -**Versions.** - - OS: - - Python: - - SQLAlchemy: - - Database: - - DBAPI: - -**Additional context** - - -**Have a nice day!** diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml new file mode 100644 index 0000000000..791c584436 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -0,0 +1,75 @@ +# docs https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms +# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema + +name: Create a bug report +description: Errors and regression reports with complete reproducing test cases and/or stack traces. +labels: [requires triage] +body: + - type: markdown + attributes: + value: " +**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%22). Each of these reports include the following features: + +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](https://stackoverflow.com/help/mcve) example. + +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. +" + - type: textarea + attributes: + label: Describe the bug + description: A clear and concise description of what the bug is. + validations: + required: true + + - type: textarea + attributes: + label: To Reproduce + description: " +Provide your [Minimal, Complete, and Verifiable](https://stackoverflow.com/help/mcve) example here." + placeholder: "# Insert code here" + render: python + validations: + required: true + + - type: textarea + attributes: + label: Error + description: " +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`` +" + placeholder: "# Copy complete stack trace and error message here, including SQL log output if applicable." + render: '' + validations: + required: true + + - type: textarea + attributes: + label: Versions + value: | + - OS: + - Python: + - SQLAlchemy: + - Database: + - DBAPI: + validations: + required: true + + - type: textarea + attributes: + label: Additional context + description: Add any other context about the problem here. + validations: + required: false + + - type: markdown + attributes: + value: "**Have a nice day!**" -- 2.47.3