Skip to content

feat: add issue templates #4

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

Merged
merged 1 commit into from
Mar 6, 2025

Conversation

robert-mitchell-iii
Copy link
Contributor

@robert-mitchell-iii robert-mitchell-iii commented Mar 4, 2025

Issue

N/A

Summary

  • This PR adds issue templates to the project.

Changes

  • Two issue templates were created:
    • feature request
    • bug report
  • The copyright year was updated to include 2025.

Notes / References

  • I opted to use issue forms as the template format, instead of Markdown.
    • This allows us to better control the format of issues that are submitted.

Checklist

  • Link to issue specified (N/A)
  • Implementation satisfies the stated objective(s)
  • Test(s) added as appropriate (N/A)
  • Documentation created/updated

Also update the year in the copyright text.
Copy link

github-actions bot commented Mar 4, 2025

Code Coverage

Total Project Coverage 98.61%

@@ -0,0 +1,40 @@
name: Feature Request
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I used Kubernetes' issue templates as a reference, while trying to preserve our "what, why, how" format.

name: Feature Request
description: Suggest a new feature or enhancement
labels:
- enhancement
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I decided to simply use the default labels for now; we can consider creating and assigning custom ones in the future 👍

Copy link

@akira-kawakatsu akira-kawakatsu left a comment

Choose a reason for hiding this comment

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

LGTM

@robert-mitchell-iii robert-mitchell-iii merged commit 55f0ceb into main Mar 6, 2025
2 checks passed
@robert-mitchell-iii robert-mitchell-iii deleted the feature/add-issue-templates branch March 6, 2025 04:52
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.

3 participants