From 41022dcd4201e1444021df69613716e9b0db7730 Mon Sep 17 00:00:00 2001 From: Brian Skinn Date: Mon, 5 Jun 2023 10:29:44 -0400 Subject: Add general issue and start of bug_report.yml --- .github/ISSUE_TEMPLATE/bug_report.yml | 57 +++++++++++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 5 +++ 2 files changed, 62 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 00000000..813898b2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,57 @@ +name: Bug Report +description: paramiko appears to be doing something wrong +title: "[BUG] - " +labels: ["Bug"] + +body: + - type: dropdown + id: usage_posture + attributes: + label: Are you using paramiko as a client or server? + multiple: false + options: + - Client + - Server + - Both + validations: + required: true + + - type: dropdown + id: features + attributes: + label: What features 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 working with? + 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 working with? + description: | + Find out with `$ python -V` + placeholder: | + Example: 3.11.3 + validations: + required: true + + \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..48cce69e --- /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: "A last resort, if none of the other issue types fits" \ No newline at end of file -- cgit v1.2.3 From 05582f5eaa02a3299fbd1255557dd25a2b1ae494 Mon Sep 17 00:00:00 2001 From: Brian Skinn <brian.skinn@gmail.com> Date: Mon, 5 Jun 2023 10:51:01 -0400 Subject: Complete first bug_report.yml draft --- .github/ISSUE_TEMPLATE/bug_report.yml | 48 ++++++++++++++++++++++++++++++++--- 1 file changed, 44 insertions(+), 4 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 813898b2..b3751cce 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -1,5 +1,5 @@ name: Bug Report -description: paramiko appears to be doing something wrong +description: For when paramiko appears to be doing something wrong title: "[BUG] - <title>" labels: ["Bug"] @@ -35,7 +35,7 @@ body: - type: input id: paramiko_version attributes: - label: What version(s) of paramiko are you working with? + label: What version(s) of paramiko are you using? description: | Find out with `$ python -c "import paramiko; print(paramiko.__version__)"` placeholder: | @@ -46,7 +46,7 @@ body: - type: input id: python_version attributes: - label: What version(s) of Python are you working with? + label: What version(s) of Python are you using? description: | Find out with `$ python -V` placeholder: | @@ -54,4 +54,44 @@ body: validations: required: true - \ No newline at end of file + - 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: hardware_info + attributes: + label: What SSH hardware are you trying to connect to/with? + + - type: textarea + id: desired_behavior + attributes: + label: Please describe what you are trying to do with paramiko. + description: | + Please include your code and be as detailed as possible. + validations: + required: true + + - type: textarea + id: actual_behavior + attributes: + label: Please describe what paramiko is actually doing instead. + description: | + Please be as detailed as possible. + validations: + required: true + + - type: textarea + id: repro + attributes: + label: If possible, please provide a minimal reproducing example of the bug. + + - type: textarea + id: more_info + attributes: + label: Anything else? -- cgit v1.2.3 From 867c2b7668a63c7f614f65e2b797460031c8157e Mon Sep 17 00:00:00 2001 From: Brian Skinn <brian.skinn@gmail.com> Date: Mon, 5 Jun 2023 10:58:27 -0400 Subject: Update bug_report.yml text --- .github/ISSUE_TEMPLATE/bug_report.yml | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index b3751cce..ff4fda6c 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -67,31 +67,37 @@ body: id: hardware_info attributes: label: What SSH hardware are you trying to connect to/with? + description: | + Leave this blank if you're not sure. - type: textarea id: desired_behavior attributes: - label: Please describe what you are trying to do with paramiko. + label: Expected/desired behavior description: | - Please include your code and be as detailed as possible. + 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: Please describe what paramiko is actually doing instead. + label: Actual behavior description: | - Please be as detailed as possible. + What is paramiko doing instead? validations: required: true - type: textarea id: repro attributes: - label: If possible, please provide a minimal reproducing example of the bug. + 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. -- cgit v1.2.3 From 4c77d4055a432680c3b79c12be9327a8056fc7e2 Mon Sep 17 00:00:00 2001 From: Brian Skinn <brian.skinn@gmail.com> Date: Mon, 5 Jun 2023 08:28:57 -0700 Subject: Re-word bug_report.yml description --- .github/ISSUE_TEMPLATE/bug_report.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index ff4fda6c..51f5573f 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -1,5 +1,6 @@ name: Bug Report -description: For when paramiko appears to be doing something wrong +description: > + For when you're confident that paramiko is doing something wrong title: "[BUG] - <title>" labels: ["Bug"] -- cgit v1.2.3 From 5be610231ca1a8e3f70e4055c2c711ada3b65c9d Mon Sep 17 00:00:00 2001 From: Brian Skinn <brian.skinn@gmail.com> Date: Tue, 6 Jun 2023 11:19:46 -0400 Subject: Revisions per bitprophet input --- .github/ISSUE_TEMPLATE/bug_report.yml | 26 +++++++++++++++++++++----- 1 file changed, 21 insertions(+), 5 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 51f5573f..d4310f4f 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -1,10 +1,17 @@ name: Bug Report -description: > - For when you're confident that paramiko is doing something wrong +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: @@ -20,7 +27,7 @@ body: - type: dropdown id: features attributes: - label: What features aren't working right? + label: What feature(s) aren't working right? description: Select as many as are relevant multiple: true options: @@ -65,11 +72,20 @@ body: required: true - type: input - id: hardware_info + id: server_info attributes: - label: What SSH hardware are you trying to connect to/with? + 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 -- cgit v1.2.3 From a5db86fb97b301f138b490e74203095d893e25a4 Mon Sep 17 00:00:00 2001 From: Brian Skinn <brian.skinn@gmail.com> Date: Tue, 6 Jun 2023 11:23:12 -0400 Subject: Remove attempt at newlines in template info line Github strips 'em out. --- .github/ISSUE_TEMPLATE/bug_report.yml | 2 -- 1 file changed, 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index d4310f4f..137c8339 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -1,8 +1,6 @@ name: Bug Report description: | Use this template when paramiko appears to be doing something wrong. - - -- title: "[BUG] - <title>" labels: ["Bug"] -- cgit v1.2.3 From 386df3102e5bad465f154205b978b9cbf95d560e Mon Sep 17 00:00:00 2001 From: Brian Skinn <brian.skinn@gmail.com> Date: Tue, 6 Jun 2023 11:24:40 -0400 Subject: Fix blank issue description --- .github/ISSUE_TEMPLATE/config.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 48cce69e..90e98d66 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -2,4 +2,4 @@ blank_issues_enabled: true contact_links: - name: "Blank issue template" url: https://github.com/paramiko/paramiko/issues/new - about: "A last resort, if none of the other issue types fits" \ No newline at end of file + about: "Use this as a last resort, if none of the other issue types fit." \ No newline at end of file -- cgit v1.2.3 From 3369b94741a8cd02fb49a455233d29940281b718 Mon Sep 17 00:00:00 2001 From: Brian Skinn <brian.skinn@gmail.com> Date: Tue, 6 Jun 2023 11:25:09 -0400 Subject: Title-case blank issue type name --- .github/ISSUE_TEMPLATE/config.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 90e98d66..717686ad 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,5 +1,5 @@ blank_issues_enabled: true contact_links: - - name: "Blank issue template" + - 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 -- cgit v1.2.3 From 068dc01cf53f46309dabde96e8a5a9e45a31f995 Mon Sep 17 00:00:00 2001 From: Brian Skinn <brian.skinn@gmail.com> Date: Tue, 27 Jun 2023 00:18:14 -0400 Subject: Add feat/support templates and rename for ordering In _theory_ they should order lexically as per the template filenames...: https://github.com/orgs/community/discussions/21601#discussioncomment-3233823 --- .github/ISSUE_TEMPLATE/10_support_request.yml | 111 ++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/20_bug_report.yml | 120 ++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/30_feature_request.yml | 73 ++++++++++++++++ .github/ISSUE_TEMPLATE/bug_report.yml | 118 ------------------------- 4 files changed, 304 insertions(+), 118 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/10_support_request.yml create mode 100644 .github/ISSUE_TEMPLATE/20_bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/30_feature_request.yml delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml diff --git a/.github/ISSUE_TEMPLATE/10_support_request.yml b/.github/ISSUE_TEMPLATE/10_support_request.yml new file mode 100644 index 00000000..91a24a84 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/10_support_request.yml @@ -0,0 +1,111 @@ +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. + + - 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/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml deleted file mode 100644 index 137c8339..00000000 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ /dev/null @@ -1,118 +0,0 @@ -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 - 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. -- cgit v1.2.3 From 7c59a1114cda5e5b5e9ecd5fb6f4ebd9ba87bd0c Mon Sep 17 00:00:00 2001 From: Brian Skinn <brian.skinn@gmail.com> Date: Tue, 27 Jun 2023 00:21:04 -0400 Subject: Add missing required flag in support request --- .github/ISSUE_TEMPLATE/10_support_request.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/10_support_request.yml b/.github/ISSUE_TEMPLATE/10_support_request.yml index 91a24a84..1da1016e 100644 --- a/.github/ISSUE_TEMPLATE/10_support_request.yml +++ b/.github/ISSUE_TEMPLATE/10_support_request.yml @@ -102,6 +102,8 @@ body: 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 -- cgit v1.2.3