-
Notifications
You must be signed in to change notification settings - Fork 191
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 Issue Templates #5278
base: development
Are you sure you want to change the base?
Create Issue Templates #5278
Conversation
2dfe56c
to
f3d6b63
Compare
Create issue templates for: - bugs - installation issues - feature requests - blank
f3d6b63
to
2209d15
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good to me! I think this will help reduce the initial back-and-forth from new issues where we usually just ask about the input script, machine setup, etc.
Just one suggestion for a possible improvement.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the update!
I guess the "usage question" template is still not made. Maybe that can be done in a follow-up PR so we can see how well these other template work in the meantime?
Thanks for your feedback, yes, I agree, this will be for sure an iterative process. The discussions page is already quite active and we can see how well this first draft works with the next new issues coming in, while refining things (like the usage question link) in follow-up PRs. I would still wait for more feedback on the current templates from other developers before merging, though, just to get as much diverse inputs and perspectives as we can. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is great! Thanks! It is already very thorough.
Is there a need for a template for pull requests (for example like with AMReX)?
Thanks! Yes, I think we could add PR templates as well, but we felt issues were more urgent since they are the more user-facing of the two. That's the only reason why we started with issues here. |
Thanks all for the feedback! I'll add your input asap. I wonder if we should rely on a check box approach if the amount of info starts to become large (maybe people find it more appealing to check boxes rather than spelling out info). I'll see if I can come up with something along these lines, for some of the info that we request, and ping you for review. |
I did a bit of work on these templates, trying to make them more uniform, so feel free to re-review if you'd like. There's a bit of repetition between the bug report and the installation issue, to be decided if we want to keep them separate or merge them. |
Create issue templates for: