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

[ENH] Adds issue templates for bugs and discussions #189

Merged
merged 8 commits into from
Feb 1, 2019
Merged

[ENH] Adds issue templates for bugs and discussions #189

merged 8 commits into from
Feb 1, 2019

Conversation

jbteves
Copy link
Collaborator

@jbteves jbteves commented Jan 21, 2019

Partially closes #186

Changes proposed in this pull request:

  • Adds bug template, discussion template

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
Copy link

codecov bot commented Jan 21, 2019

Codecov Report

Merging #189 into master will decrease coverage by 0.15%.
The diff coverage is n/a.

Impacted file tree graph

@@            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
Impacted Files Coverage Δ
tedana/workflows/t2smap.py 67.1% <0%> (-2.76%) ⬇️
tedana/workflows/tedana.py 11.34% <0%> (-0.25%) ⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 0b4e0e3...09da2c7. Read the comment docs.

@codecov
Copy link

codecov bot commented Jan 21, 2019

Codecov Report

Merging #189 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

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

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 0b4e0e3...d8c3611. Read the comment docs.

@jbteves jbteves changed the title Adds issue templates for bugs and discussions [ENH] Adds issue templates for bugs and discussions Jan 23, 2019
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
@jbteves
Copy link
Collaborator Author

jbteves commented Jan 25, 2019

You can view the new template here

@jbteves
Copy link
Collaborator Author

jbteves commented Jan 30, 2019

@tsalo @emdupre @KirstieJane Any thoughts on this? Happy to make changes if desired.

Copy link
Member

@emdupre emdupre left a 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 !

.github/ISSUE_TEMPLATE/issue_template.md Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/issue_template.md Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/issue_template.md Outdated Show resolved Hide resolved
### Next Steps

<!--
Thank you for submitting your issue!
Copy link
Member

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 ?

Copy link
Collaborator Author

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 😄

Copy link
Member

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 ?

Copy link
Member

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.

Copy link
Collaborator Author

@jbteves jbteves Jan 31, 2019

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.

@emdupre
Copy link
Member

emdupre commented Jan 31, 2019

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.
@emdupre
Copy link
Member

emdupre commented Feb 1, 2019

I chatted with @KirstieJane offline about this and got approval to go forward 👍

Thanks so much again, @jbteves ! ✨ 🚀

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.

Create an issue template
3 participants