pypa / gh-action-pip-audit

A GitHub Action for pip-audit
https://github.com/marketplace/actions/gh-action-pip-audit
Apache License 2.0
68 stars 12 forks source link

New issue templates #37

Closed tnytown closed 1 year ago

tnytown commented 1 year ago

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.

tnytown commented 1 year ago

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.

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.

woodruffw commented 1 year ago

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.

tnytown commented 1 year ago

I've updated the forms in my fork! How do they look?