-
Notifications
You must be signed in to change notification settings - Fork 95
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
[ENH] Adds issue templates for bugs and discussions #189
Conversation
Integrates with GitHub's issues template feature. Provides fields for bug summary, suspected causes and additional details such as OS/Python version. Can modify by modifying /.github/ISSUE_TEMPLATE/bug_issue.md. See https://help.github.com/articles/manually-creating-a-single-issue-template-for-your-repository/ for more information, strategy employed is #3.
Adds fields for discussion issue, including summary, goals and optionally strategy and additional details. For modification notes reference the previous commmit, 11ca2fe
Codecov Report
@@ Coverage Diff @@
## master #189 +/- ##
==========================================
- Coverage 51.58% 51.42% -0.16%
==========================================
Files 32 32
Lines 1958 1964 +6
==========================================
Hits 1010 1010
- Misses 948 954 +6
Continue to review full report at Codecov.
|
Codecov Report
@@ Coverage Diff @@
## master #189 +/- ##
=======================================
Coverage 51.58% 51.58%
=======================================
Files 32 32
Lines 1958 1958
=======================================
Hits 1010 1010
Misses 948 948 Continue to review full report at Codecov.
|
Per discussions on PR#189, bug and discussions templates are condensed into one general issue template. Template contains fields for summary, additional detail and next steps. Co-authored-by: Taylor Salo Co-authored-by: Elizabeth DuPre
You can view the new template here |
@tsalo @emdupre @KirstieJane Any thoughts on this? Happy to make changes if desired. |
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 looks great ! I had a few small wording suggestions and some general questions. Excited to see this merged !
### Next Steps | ||
|
||
<!-- | ||
Thank you for submitting your issue! |
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.
General question to the group -- should we establish some sort of timeline ? Like, if you don't hear back after X days, please ping again ?
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.
I think that would be good. For me personally, I would say one calendar week. But I'm not the one likely to be tagged/notified 😄
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.
I think if we're clear that it won't necessarily be dealt with in one week, just acknowledged, then that seems very reasonable to me. WDYT @tsalo @KirstieJane ?
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.
LGTM. There's just one typo to fix and then I think it's ready to merge, pending @KirstieJane's input.
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.
@tsalo @emdupre @KirstieJane please see if 09da2c7 addresses the timeline in the way you'd like.
This LGTM ! I'd just to like resolve the one remaining question on our response timeline (if any). |
Addresses comments from #189 (comment) and #189 (comment) that note typos.
Addresses comments at #189 (comment) which request a response time guideline, and notes that the issue may not be resolved right away.
I chatted with @KirstieJane offline about this and got approval to go forward 👍 Thanks so much again, @jbteves ! ✨ 🚀 |
Partially closes #186
Changes proposed in this pull request: