From ace2c7dcf568698262b07241d4d5dcd6de04ab1a Mon Sep 17 00:00:00 2001 From: Andrew Pan Date: Fri, 24 Mar 2023 12:03:03 -0500 Subject: [PATCH 1/2] ISSUE_TEMPLATE: initial templates Signed-off-by: Andrew Pan --- .github/ISSUE_TEMPLATE/bug_report.md | 32 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 11 ++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 17 ++++++++++++ 3 files changed, 60 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..2da1736 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,32 @@ +--- +name: Bug report +about: Report a bug with pip-audit's GitHub Action +labels: bug +--- + + + +### Current behavior + + + +### Expected behavior + + + +### Steps to reproduce + + + diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..ff27519 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,11 @@ +blank_issues_enabled: false +contact_links: + - name: pip-audit's issue tracker + url: https://github.com/pypa/pip-audit/issues/new/choose + about: >- + You may want to file a report on pip-audit instead if your issue is not + directly related to this GitHub Action + - name: Troubleshooting guide + url: https://github.com/pypa/gh-action-pip-audit#troubleshooting + about: >- + Learn how to fix some common issues or enable debug logging here diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..c35d3dd --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,17 @@ +--- +name: Feature request +about: Suggest an idea for pip-audit's GitHub Action +labels: enhancement +--- + +### Is your feature request related to a problem? Please describe. + + +### Describe the solution you'd like + + +### Describe alternatives you've considered + + +### Additional context + From d5f13f7587e469ae4020783f5f5d54e4a15a8598 Mon Sep 17 00:00:00 2001 From: Andrew Pan Date: Fri, 24 Mar 2023 21:50:57 -0500 Subject: [PATCH 2/2] ISSUE_TEMPLATE/bug_report: use form format Signed-off-by: Andrew Pan --- .github/ISSUE_TEMPLATE/bug_report.md | 32 ----------- .github/ISSUE_TEMPLATE/bug_report.yml | 64 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 17 ------ .github/ISSUE_TEMPLATE/feature_request.yml | 50 +++++++++++++++++ 4 files changed, 114 insertions(+), 49 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 2da1736..0000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -name: Bug report -about: Report a bug with pip-audit's GitHub Action -labels: bug ---- - - - -### Current behavior - - - -### Expected behavior - - - -### Steps to reproduce - - - diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..f931fc5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,64 @@ +name: Bug report +description: Report a bug with pip-audit's GitHub Action +labels: bug +body: + - type: markdown + attributes: + value: >- + Thank you for reporting a potential bug in `gh-action-pip-audit`! Please + read the following carefully: + + + **IMPORTANT:** This issue tracker is for `pip-audit`'s + **GitHub Action**, the scaffolding that integrates `pip-audit` with your + CI. If the buggy behavior you are experiencing appears to be in + `pip-audit`, please file an issue + [against the `pip-audit` repo](https://github.com/pypa/pip-audit/issues/new/choose). + + + **IMPORTANT:** Please fill out every section below. Bug reports with + missing information will be given a lower priority or closed outright. + + + Before filing an issue, check out our + [troubleshooting guide](https://github.com/pypa/gh-action-pip-audit#troubleshooting) :) + - type: textarea + id: current-behavior + attributes: + label: Current behavior + description: >- + What issue are you having with the action? What were you trying to do + when the issue occurred? + placeholder: The action run succeeds when I ... + validations: + required: true + - type: textarea + id: expected-behavior + attributes: + label: Expected behavior + description: What should've happened instead? + placeholder: I expected the action run to fail. + validations: + required: true + - type: textarea + id: repro + attributes: + label: Steps to reproduce + description: What are the detailed steps we can follow to trigger this issue? + placeholder: |- + 1. ... + 2. ... + 3. ... + validations: + required: true + - type: textarea + id: context + attributes: + label: Relevant context + description: >- + Please include a link to an action run, as well as any logs that you think might + be helpful! You can + [follow these instructions](https://docs.github.com/en/actions/managing-workflow-runs/re-running-workflows-and-jobs#re-running-all-the-jobs-in-a-workflow) + to re-run the action with debug logging. + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index c35d3dd..0000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for pip-audit's GitHub Action -labels: enhancement ---- - -### Is your feature request related to a problem? Please describe. - - -### Describe the solution you'd like - - -### Describe alternatives you've considered - - -### Additional context - diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..c83f913 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,50 @@ +name: Feature request +description: Suggest an idea for pip-audit's GitHub Action +labels: enhancement +body: + - type: markdown + attributes: + value: >- + Thank you for filing a feature request for `gh-action-pip-audit`! Please + read the following carefully: + + + **IMPORTANT:** This form is for `pip-audit`'s **GitHub Action**, the + scaffolding that integrates `pip-audit` with your CI. If you would like + a new feature in `pip-audit` itself, please go to + [the `pip-audit` repo](https://github.com/pypa/pip-audit/issues/new/choose). + + + **IMPORTANT:** Please fill out every required section below to the best + of your ability. Feature requests with missing information may be given + a lower priority or closed outright. + - type: textarea + id: problem + attributes: + label: Is your feature request related to a problem? + description: Describe how the current solution is deficient. + placeholder: I am frustrated when ... + validations: + required: true + - type: textarea + id: solution + attributes: + label: Describe the solution you'd like + description: + placeholder: I think gh-action-pip-audit would benefit from ... + validations: + required: true + - type: textarea + id: alternatives-considered + attributes: + label: Alternative solutions or features you've considered + description: + placeholder: + validations: + required: true + - type: textarea + id: context + attributes: + label: Additional context + description: Add any context or screenshots related to the feature request. + placeholder: