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.

Sign up for GitHub

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

Jump to bottom

Add issue templates #237

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

Add issue templates #237

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
833b06d
Add issue templates
haydentherapper Feb 22, 2024
aa749c5
Create issue-or-enhancement.md
haydentherapper Feb 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
17 changes: 17 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
name: Bug
about: Something wrong with the project? Report it here!
labels: 'bug'
assignees: ''

---

**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.


<!--Tell us about the bug. What went wrong? How can we reproduce it? What should the correct behavior be?
-->

**Version**

<!--What version are you using? e.g. `cosign version`...
-->
14 changes: 14 additions & 0 deletions .github/ISSUE_TEMPLATE/issue-or-enhancement.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
name: Issue or Enhancement
about: A task or enhancement idea related to the technical aspects of
the project.
labels: 'enhancement'
assignees: ''

---

**Description**

<!--What needs to be improved? What should be done? Has there been any related work
before? Any relevant links or material?
-->