From 6bc755d2ab9235ce4c3670ed3c3c3799d6c4ad5e Mon Sep 17 00:00:00 2001 From: Federico Caselli Date: Mon, 26 Jul 2021 10:00:23 -0400 Subject: [PATCH] New issue templates forms Noting fancy. we could add checkbox and/or dropdowns if needed **To test**: to go my fork. Link https://github.com/CaselIT/sqlalchemy/issues/new/choose See docs at 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 Closes: #6809 Pull-request: https://github.com/sqlalchemy/sqlalchemy/pull/6809 Pull-request-sha: 21beb5a44104ced9e43bb5342a4cdf5f5efcb02a Change-Id: I74c671aa2790b9f08c20b0659625c8a91b5b9c72 --- .github/ISSUE_TEMPLATE/bug_report.md | 56 ------------------- .github/ISSUE_TEMPLATE/bug_report.yaml | 77 ++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/use_case.md | 24 -------- .github/ISSUE_TEMPLATE/use_case.yaml | 38 +++++++++++++ 4 files changed, 115 insertions(+), 80 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yaml delete mode 100644 .github/ISSUE_TEMPLATE/use_case.md create mode 100644 .github/ISSUE_TEMPLATE/use_case.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..500d5bf32c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -0,0 +1,77 @@ +# 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. +If you need help creating one, you can model yours after the MCV code shared in one of our previous +[well written bug reports](https://github.com/sqlalchemy/sqlalchemy/issues?q=is%3Aissue+label%3A%22great+mcve%22)" + 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!**" diff --git a/.github/ISSUE_TEMPLATE/use_case.md b/.github/ISSUE_TEMPLATE/use_case.md deleted file mode 100644 index 8677cb556f..0000000000 --- a/.github/ISSUE_TEMPLATE/use_case.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -name: Request a new use case -about: Support for new SQL syntaxes, database capabilities, DBAPIs and DBAPI features -title: '' -labels: requires triage,use case -assignees: '' - ---- - -**Describe the use case** - - -**Databases / Backends / Drivers targeted** - - - -**Example Use** - - - -**Additional context** - - -**Have a nice day!** diff --git a/.github/ISSUE_TEMPLATE/use_case.yaml b/.github/ISSUE_TEMPLATE/use_case.yaml new file mode 100644 index 0000000000..987000254d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/use_case.yaml @@ -0,0 +1,38 @@ +# 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: Request a new use case +description: Support for new SQL syntaxes, database capabilities, DBAPIs and DBAPI features +labels: [requires triage,use case] +body: + - type: textarea + attributes: + label: Describe the use case + description: A clear and concise description of what the SQL or database capability is. + validations: + required: true + + - type: textarea + attributes: + label: Databases / Backends / Drivers targeted + description: What database(s) is this for? What drivers? + validations: + required: true + + - type: textarea + attributes: + label: Example Use + description: Provide a clear example of what the SQL looks like, or what the DBAPI code looks like + validations: + required: true + + - type: textarea + attributes: + label: Additional context + description: Add any other context about the use case here. + validations: + required: false + + - type: markdown + attributes: + value: "**Have a nice day!**" -- 2.47.2