search

fNIRS / snirf

SNIRF Format Specification
http://fnirs.org/resources/software/snirf/
Other
57 stars 33 forks source link

Adding issue templates #138

Closed Horschig closed 4 months ago

Horschig commented 6 months ago

I am adding issue templates to accomodate https://github.com/fNIRS/snirf/issues/76

Please feel free to change, suggest to existing files or add new files.

Horschig commented 6 months ago

@samuelpowell @rob-luke @dboas what do you think about the issue templates? Is there any issue template you are missing?

samuelpowell commented 6 months ago

Since this repository is for a specification, rather than an implementation, I don't think we should encourage people to report bugs in the implementation of third party packages here. As such, I'd suggest limiting the templates to 'error reports' (in the context of an inconsistent specification ), and 'suggestions'.

dboas commented 6 months ago

I like the question and suggestion templates. I agree with Samuel that we shouldn't encourage discussion about implementation bugs in third party packages. If this recurs, we can update the readme to direct people to report such issues to the developer of the third party package.

Help me better learn GitHub... what do we do next? Does Jorn remove the bugs template and then two of us approve it? Or maybe more discussion is needed first?

Horschig commented 6 months ago

I (or anyone else) can change or delete the templates or add new ones. I marked this PR as a draft so that it cannot be approved yet, but thereafter as soon as you agree, you can approve it. Templates can always be changes later anyway, so it does not make much sense to wait (plus with open source projects and external collaborators, you never know how active they are and they might keep a PR open for an eternity :) ).

I'll quickly change the bug template to be an error report, and I'll include that we do not provide support for toolboxes here.

Horschig commented 6 months ago

I decided to call it inconsistency instead of error (which is purely because I think inconsistency is a better match). Please let me know what you think, and feel free to make any suggestions (I am not too picky about any of these here, just want to help).

samuelpowell commented 6 months ago

Inconsistency / Suggestion look fine. However I don’t see the point of the Question template in its current form; if someone has a useful question (e.g. something which will eventually become an inconsistency or suggest report) it’s too constraining, and if they do not, the template isn’t going to help.

(Also, there are a number of typos in the Question template which need to be resolved if it is to be used.)

Horschig commented 5 months ago

I fixed the typos.

I don't think it is too constraining, because users are not forced to use the template as it. They can edit the whole text when creating an issue. It is just a guideline. Plus, we just got a question that was asked without a template, and see how it turned out... ;)

https://github.com/fNIRS/snirf/issues/140

samuelpowell commented 4 months ago

@dboas you need to approve in review (go to the 'Files Changed' tab, click the green 'Review changes', and proceed as you see fit)

dboas commented 4 months ago

approved. should I squash and merge?