From 4d2f24e524c99d8255f451476679f5fa93647ad4 Mon Sep 17 00:00:00 2001
From: Federico Caselli <cfederico87@gmail.com>
Date: Mon, 23 Jan 2023 21:34:25 +0100
Subject: [PATCH] add typing issue template

Change-Id: I429bf499274362e53ab3e7ea0f65c0ef5265a14d
---
 .github/ISSUE_TEMPLATE/bug_report.yaml |  8 +--
 .github/ISSUE_TEMPLATE/typing.yaml     | 68 ++++++++++++++++++++++++++
 2 files changed, 72 insertions(+), 4 deletions(-)
 create mode 100644 .github/ISSUE_TEMPLATE/typing.yaml

diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml
index bcb25b8063..ee2fc54593 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.yaml
+++ b/.github/ISSUE_TEMPLATE/bug_report.yaml
@@ -1,7 +1,7 @@
 # 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
+name: Create a bug report regarding SQLAlchemy runtime behavior
 description: Errors and regression reports with complete reproducing test cases and/or stack traces.
 labels: [requires triage]
 body:
@@ -66,7 +66,7 @@ of [well written bug reports](https://github.com/sqlalchemy/sqlalchemy/issues?q=
 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"
+      placeholder: "# Insert code here (text area already python formatted)"
       render: python
     validations:
       required: true
@@ -78,11 +78,11 @@ If you need help creating one, you can model yours after the MCV code shared in
 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."
+      placeholder: "# Copy the complete stack trace and error message here, including SQL log output if applicable."
       value: "\
 ```
 
-# Copy complete stack trace and error message here, including SQL log output if applicable.
+# Copy the complete stack trace and error message here, including SQL log output if applicable.
 
 ```
 "
diff --git a/.github/ISSUE_TEMPLATE/typing.yaml b/.github/ISSUE_TEMPLATE/typing.yaml
new file mode 100644
index 0000000000..e6cff945e1
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/typing.yaml
@@ -0,0 +1,68 @@
+# 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: Report a typing issue found by type checkers
+description: Typing errors or annoyances while using SQLAlchemy with mypy, pyright, etc.
+labels: [requires triage,typing]
+body:
+  - type: markdown
+    attributes:
+      value: "SQLAlchemy v2 introduced typing support on most common public apis, but the work to fully type
+all the pubic api is still in progress.
+
+Currently the SQLAlchemy team is targeting mypy support, with best effort support for other type checkers.
+"
+
+  - type: textarea
+    attributes:
+      label: Describe the typing issue
+      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 (text area already python formatted)"
+      render: python
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Error
+      description: Provide the complete text of any errors received by the type checker(s).
+      placeholder: "# Copy the complete text of any errors received by the type checker(s)."
+      value: "\
+```
+
+# Copy the complete text of any errors received by the type checker(s).
+
+```
+"
+
+  - type: textarea
+    attributes:
+      label: Versions
+      value: |
+        - OS:
+        - Python:
+        - SQLAlchemy:
+        - Type checker (eg: mypy 0.991, pyright 1.1.290, etc):
+    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.2