-
Notifications
You must be signed in to change notification settings - Fork 12
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
New issue templates #37
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good on first blush, two thoughts:
- Let's add a warning (similar to the one in
pip-audit
's bug template) saying that we'll close or deprioritize reports that don't fill in all of the report's sections. - Let's add a notice reminding people to report bugs to
pip-audit
rather than this repo, if the buggy behavior in question appears to be solely inpip-audit
rather than in this action's scaffolding.
For reference: https://github.com/pypa/pip-audit/issues/new?assignees=&labels=bug-candidate&template=bug_report.md&title=
Hm, do we want to use issue forms? We can split the issue filing GUI into multiple fields and require input for each of those fields. |
Yes! I've seen these around, but I didn't know the right set of keywords to search to find the docs for them. We should absolutely use these. |
I've updated the forms in my fork! How do they look? |
Signed-off-by: Andrew Pan <[email protected]>
Signed-off-by: Andrew Pan <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, thanks!
In this changeset, I've cribbed some issue templates from GitHub's issue template templates. I also added links to
pip-audit
's issue tracker and the troubleshooting section in our README.Here's how the changes look:
https://github.com/tnytown/gh-action-pip-audit/issues/new/choose
I don't love how the feature request template is worded, but I also don't know how I would change it. Suggestions welcome!
Resolves #31.