Merge pull request #2265 from bskinn/add-issue-templatesHEADmain

[ADMIN] Add issue templates for support request, bug report, feature request

4 files changed, 311 insertions, 0 deletions

diff --git a/.github/ISSUE_TEMPLATE/10_support_request.yml b/.github/ISSUE_TEMPLATE/10_support_request.yml
new file mode 100644
index 00000000..1da1016e
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/10_support_request.yml
@@ -0,0 +1,113 @@
+name: Support Request
+description: |
+  Use this template when you're having trouble using paramiko.
+title: "[SUPPORT] - <title>"
+labels: ["Support"]
+
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for using paramiko! We're sorry you're having trouble making it work the way you want. Please provide the information below and describe the problem you're having and we'll do our best to help.
+
+  - type: dropdown
+    id: usage_posture
+    attributes:
+      label: Are you using paramiko as a client or server?
+      multiple: false
+      options:
+        - Client
+        - Server
+        - Both
+        - Not sure
+    validations:
+      required: true
+
+  - type: dropdown
+    id: features
+    attributes:
+      label: What feature(s) aren't working right?
+      description: Select as many as are relevant
+      multiple: true
+      options:
+        - SSH
+        - SFTP
+        - Keys/auth
+        - known_hosts
+        - sshconfig
+        - Exception handling
+        - Something else
+    validations:
+      required: true
+  
+  - type: input
+    id: paramiko_version
+    attributes:
+      label: What version(s) of paramiko are you using?
+      description: |
+        Find out with `$ python -c "import paramiko; print(paramiko.__version__)"`
+      placeholder: |
+        Example: 3.1.0
+    validations:
+      required: true
+
+  - type: input
+    id: python_version
+    attributes:
+      label: What version(s) of Python are you using?
+      description: |
+        Find out with `$ python -V`
+      placeholder: |
+        Example: 3.11.3
+    validations:
+      required: true
+
+  - type: input
+    id: os_info
+    attributes:
+      label: What operating system and version are you using?
+      placeholder: |
+        Example: WSL on Windows 11; or MacOS Mojave; or Ubuntu 22.10
+    validations:
+      required: true
+
+  - type: input
+    id: server_info
+    attributes:
+      label: If you're connecting as a client, which SSH server are you connecting to?
+      description: |
+        Leave this blank if you're not sure.
+      placeholder: |
+        Example: OpenSSH x.y; or Teleport vNN
+
+  - type: input
+    id: integrated_tool
+    attributes:
+      label: If you're using paramiko as part of another tool, which tool/version?
+      placeholder: |
+        Examples: Fabric, Ansible, sftputil
+  
+  - type: textarea
+    id: intended_use
+    attributes:
+      label: What are you trying to do with paramiko?
+      description: |
+        Please describe in words what you are trying to do.
+    validations:
+      required: true
+
+  - type: textarea
+    id: problem_details
+    attributes:
+      label: How are you trying to do it, and what's happening instead?
+      description: |
+        Include code snippets and a description of the expected output, and be as detailed as possible. If possible, try to reduce your code examples to a minimal example that reproduces the problem/behavior.
+    validations:
+      required: true
+
+  - type: textarea
+    id: more_info
+    attributes:
+      label: Anything else?
+      description: |
+        Please provide any additional information that might help us find a solution for you.
diff --git a/.github/ISSUE_TEMPLATE/20_bug_report.yml b/.github/ISSUE_TEMPLATE/20_bug_report.yml
new file mode 100644
index 00000000..82f90663
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/20_bug_report.yml
@@ -0,0 +1,120 @@
+name: Bug Report
+description: |
+  Use this template when paramiko appears to be doing something wrong.
+title: "[BUG] - <title>"
+labels: ["Bug"]
+
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to file a bug report!
+
+  - type: dropdown
+    id: usage_posture
+    attributes:
+      label: Are you using paramiko as a client or server?
+      multiple: false
+      options:
+        - Client
+        - Server
+        - Both
+        - Exception handling
+        - Not sure
+    validations:
+      required: true
+
+  - type: dropdown
+    id: features
+    attributes:
+      label: What feature(s) aren't working right?
+      description: Select as many as are relevant
+      multiple: true
+      options:
+        - SSH
+        - SFTP
+        - Keys/auth
+        - known_hosts
+        - sshconfig
+        - Something else
+    validations:
+      required: true
+  
+  - type: input
+    id: paramiko_version
+    attributes:
+      label: What version(s) of paramiko are you using?
+      description: |
+        Find out with `$ python -c "import paramiko; print(paramiko.__version__)"`
+      placeholder: |
+        Example: 3.1.0
+    validations:
+      required: true
+
+  - type: input
+    id: python_version
+    attributes:
+      label: What version(s) of Python are you using?
+      description: |
+        Find out with `$ python -V`
+      placeholder: |
+        Example: 3.11.3
+    validations:
+      required: true
+
+  - type: input
+    id: os_info
+    attributes:
+      label: What operating system and version are you using?
+      placeholder: |
+        Example: WSL on Windows 11; or MacOS Mojave; or Ubuntu 22.10
+    validations:
+      required: true
+
+  - type: input
+    id: server_info
+    attributes:
+      label: If you're connecting as a client, which SSH server are you connecting to?
+      description: |
+        Leave this blank if you're not sure.
+      placeholder: |
+        Example: OpenSSH x.y; or Teleport vNN
+
+  - type: input
+    id: integrated_tool
+    attributes:
+      label: If you're using paramiko as part of another tool, which tool/version?
+      placeholder: |
+        Examples: Fabric, Ansible, sftputil
+  
+  - type: textarea
+    id: desired_behavior
+    attributes:
+      label: Expected/desired behavior
+      description: |
+        Please describe what you are trying to do with paramiko. Include code snippets and be as detailed as possible.
+    validations:
+      required: true
+  
+  - type: textarea
+    id: actual_behavior
+    attributes:
+      label: Actual behavior
+      description: |
+        What is paramiko doing instead?
+    validations:
+      required: true
+  
+  - type: textarea
+    id: repro
+    attributes:
+      label: How to reproduce
+      description: |
+        If possible, please provide a minimal code example that reproduces the bug.
+  
+  - type: textarea
+    id: more_info
+    attributes:
+      label: Anything else?
+      description: |
+        Please provide any additional information that might help us find and fix the bug.
diff --git a/.github/ISSUE_TEMPLATE/30_feature_request.yml b/.github/ISSUE_TEMPLATE/30_feature_request.yml
new file mode 100644
index 00000000..ac3bef27
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/30_feature_request.yml
@@ -0,0 +1,73 @@
+name: Feature Request
+description: |
+  Use this template to request addition of a new paramiko feature.
+title: "[FEAT] - <title>"
+labels: ["Feature"]
+
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to let us know what you'd like added to paramiko!
+
+  - type: dropdown
+    id: usage_posture
+    attributes:
+      label: Is this feature for paramiko acting as a client or a server?
+      multiple: false
+      options:
+        - Client
+        - Server
+        - Both
+        - Not sure
+    validations:
+      required: true
+
+  - type: dropdown
+    id: features
+    attributes:
+      label: What functionality does this feature request relate to?
+      description: Select as many as are relevant
+      multiple: true
+      options:
+        - SSH
+        - SFTP
+        - Keys/auth
+        - known_hosts
+        - sshconfig
+        - Exception handling
+        - Something else
+    validations:
+      required: true
+
+  - type: input
+    id: server_info
+    attributes:
+      label: For client-side features, does this relate to a specific type of SSH server?
+      description: |
+        Leave this blank if you're not sure, or if you're requesting a server-side feature.
+      placeholder: |
+        Example: OpenSSH x.y; or Teleport vNN
+
+  - type: input
+    id: integrated_tool
+    attributes:
+      label: If you're using paramiko as part of another tool, which tool/version?
+      placeholder: |
+        Examples: Fabric, Ansible, sftputil
+  
+  - type: textarea
+    id: desired_behavior
+    attributes:
+      label: Desired behavior
+      description: |
+        Please describe what you you would like paramiko to be able to do. If possible, include pseudocode or mock code snippets to illustrate the desired behavior, and be as detailed as possible.
+    validations:
+      required: true
+  
+  - type: textarea
+    id: more_info
+    attributes:
+      label: Anything else?
+      description: |
+        Please provide any additional information that would be helpful to provide context for your requested feature.
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
new file mode 100644
index 00000000..717686ad
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,5 @@
+blank_issues_enabled: true
+contact_links:
+  - name: "Blank Issue Template"
+    url: https://github.com/paramiko/paramiko/issues/new
+    about: "Use this as a last resort, if none of the other issue types fit."
\ No newline at end of file