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

Create a issue template for bugs #912

Merged
merged 6 commits into from
Nov 19, 2024
Merged

Create a issue template for bugs #912

merged 6 commits into from
Nov 19, 2024

Conversation

misko
Copy link
Collaborator

@misko misko commented Nov 12, 2024

Add an intake form for tracking bugs, require information about the system and reproducible example. Parts have been borrowed from pymatgen intake form.

@misko misko requested review from rayg1234 and lbluque November 12, 2024 22:15
@misko misko added enhancement New feature or request patch Patch version release labels Nov 12, 2024
Copy link

codecov bot commented Nov 12, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅


🚨 Try these New Features:

lbluque
lbluque previously approved these changes Nov 13, 2024
Copy link
Collaborator

@lbluque lbluque left a comment

Choose a reason for hiding this comment

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

Thanks @misko This looks great!

Should we add more templates (ie for documentation suggestions, feature requests, etc)?

I really like the setup in quacc as an example: https://github.com/Quantum-Accelerators/quacc/tree/main/.github/ISSUE_TEMPLATE

@misko
Copy link
Collaborator Author

misko commented Nov 13, 2024

@lbluque This makes sense! I added in at least "other" / misc , so after merging someone can at least use that to file a non bug issue.
Maybe we can discuss in person about which other ones to add?

id: code-snippet
attributes:
label: Minimal example
description: Please provide a minimal code snippet to reproduce this bug.
Copy link
Collaborator

Choose a reason for hiding this comment

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

this isn't always applicable right? we allow this be blank?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

right, this field is not required

Copy link
Collaborator

@rayg1234 rayg1234 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 for adding this!

@misko misko enabled auto-merge November 19, 2024 19:26
@misko misko added this pull request to the merge queue Nov 19, 2024
Merged via the queue into main with commit 8e20886 Nov 19, 2024
10 checks passed
@misko misko deleted the add_issue_intake branch November 19, 2024 21:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request patch Patch version release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants