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

Add issue templates #237

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Add issue templates #237

wants to merge 2 commits into from

Conversation

haydentherapper
Copy link
Collaborator

Since we've added an issue template in the repo, it means we won't inherit templates from the organization (https://github.com/sigstore/.github/tree/main/.github/ISSUE_TEMPLATE). This duplicates the bug and enhancement templates

Summary

Release Note

Documentation

Since we've added an issue template in the repo, it means we won't inherit templates from the organization (https://github.com/sigstore/.github/tree/main/.github/ISSUE_TEMPLATE). This duplicates the bug and enhancement templates

Signed-off-by: Hayden B <hblauzvern@google.com>
Signed-off-by: Hayden B <hblauzvern@google.com>

---

**Description**
Copy link
Member

Choose a reason for hiding this comment

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

Is this the standard template for Sigstore project?

If not I would think about having sections (beyond just description and version):

  • What did you observe
  • What was the expected outcome
  • Steps to reproduce

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

This is the standard template from https://github.com/sigstore/.github/tree/main/.github/ISSUE_TEMPLATE, I didn't want to change it. We could update the org-wide issue templates first?

Copy link
Member

Choose a reason for hiding this comment

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

I'm +1 on adding those additional sections, but either way (upstream or direct here) seems reasonable to me 🙂

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

FWIW, the description asks for these details.

@woodruffw
Copy link
Member

As a side-note: if we want to be even more structured here, we could use issue forms instead of templates.

@haydentherapper
Copy link
Collaborator Author

As a side-note: if we want to be even more structured here, we could use issue forms instead of templates.

Oh neat! I'll take a look at that.

@woodruffw
Copy link
Member

Oh neat! I'll take a look at that.

This reminded me that I meant to do it for pip-audit months ago, so if you want some reference samples 🙂: pypa/pip-audit#741

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants