Skip to content
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

Merged
merged 2 commits into from
Mar 28, 2023
Merged

New issue templates #37

merged 2 commits into from
Mar 28, 2023

Conversation

tnytown
Copy link
Member

@tnytown tnytown commented Mar 24, 2023

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 tnytown added the enhancement New feature or request label Mar 24, 2023
@tnytown tnytown self-assigned this Mar 24, 2023
Copy link
Member

@woodruffw woodruffw left a 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:

  1. 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.
  2. 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 in pip-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=

@tnytown
Copy link
Member Author

tnytown commented Mar 25, 2023

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
Copy link
Member

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
Copy link
Member Author

tnytown commented Mar 25, 2023

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

Signed-off-by: Andrew Pan <a@tny.town>
Signed-off-by: Andrew Pan <a@tny.town>
Copy link
Member

@woodruffw woodruffw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks!

@woodruffw woodruffw merged commit 28aa5e1 into pypa:main Mar 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create an issue template to redirect (some) users to pip-audit
2 participants