Skip to content

Commit

Permalink
New issue templates (#37)
Browse files Browse the repository at this point in the history
  • Loading branch information
tnytown committed Mar 28, 2023
1 parent 1abec09 commit 28aa5e1
Show file tree
Hide file tree
Showing 3 changed files with 125 additions and 0 deletions.
64 changes: 64 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -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
11 changes: 11 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -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
50 changes: 50 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -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:

0 comments on commit 28aa5e1

Please sign in to comment.