We should create an issue template to avoid us having to ask for commonly-needed information. Things we need for bug reports:
1) Version of fMRIPrep being run.
2) Full command (specific directories could be obscured) including docker, singularity, or fmriprep-docker
3) If still running, are any processes consuming large amounts of memory/CPU, as determined by top/htop?
Anything else?
And bugs/support aren't the only issues; we should probably include language to prompt good feature requests (e.g. references to papers for new techniques, etc.) or discussion topics.
effigies
All 11 comments
great idea!
Perhaps not in the issue template, but I think there should be some inclusion about docker's default limitation of 2gb RAM in mac and windows installations, I've seen that as being a common tripping point for users.
jdkent
on 1 Aug 2018
We do have a infrequently-updated FAQ. We can add that, and have users check off a box saying "I have searched the FAQ for my issue" or similar.
effigies
on 1 Aug 2018
If no one is already working on this, I would give it a try.
PeerHerholz
on 6 Nov 2019
That's fine with me. Does anybody have experience with issue templates where users don't ignore them? That might be useful for designing one.
effigies
on 6 Nov 2019
One thing I really like is having different types of issues - we implemented something like that in pydra
mgxd
on 6 Nov 2019
Yeah, definitely a big fan of those. This also relates to @effigies comment here regarding different issue types. So, bugs and feature request are safe bets. Any thoughts on other potential types?
PeerHerholz
on 6 Nov 2019
repronim has a section describing what should go into a bug report
We could have a question template that could potentially redirect the asker to neurostars if the question is more appropriate for that platform, and try to draw the boundary between what types of questions belong here versus neurostars.
A recent comment by @effigies provides indication of which questions go where.
jdkent
on 6 Nov 2019
+1 on bug report, feature request, and question as categories !
I also suggested to @oesteban that we look into adding Discourse Topic Templates to NeuroStars, so we could have an ideal NeuroStars issue template in mind when writing these, if that helps to distinguish use cases.
emdupre
on 6 Nov 2019
@emdupre can I ask you to take ownership of this one and help @PeerHerholz in implementing it?
oesteban
on 6 Nov 2019
Should this have been closed by #2012?
tsalo
on 17 Aug 2020
Yup. Thanks.
effigies
on 17 Aug 2020
Related issues
sameera2004
路
22Comments
oricon
路
39Comments
nblauch
路
20Comments
soyfrien
路
23Comments
chrisgorgo
路
35Comments
Most helpful comment
repronim has a section describing what should go into a bug report
We could have a
questiontemplate that could potentially redirect the asker to neurostars if the question is more appropriate for that platform, and try to draw the boundary between what types of questions belong here versus neurostars.A recent comment by @effigies provides indication of which questions go where.