search

GreycLab / gmic

GREYC's Magic for Image Computing: A Full-Featured Open-Source Framework for Image Processing
Other
66 stars 11 forks source link

[JOSS] No testing instructions #57

Closed jamesrhester closed 2 months ago

jamesrhester commented 2 months ago

JOSS reviewer here (see here). One of the JOSS requirements is clear testing instructions. I couldn't find anything like this in the g'mic repository or docs.

Of course, testing whether an image has changed the way you want it to is a bit hard to automate, so I suggest simply adding a 'Testing' section to the 'Download' page, pointing the user to the "resources/samples" directory of this repository and advising that the user checks that all scripts work (perhaps explaining how to run them).

Or perhaps just running gmic demo is sufficient.

dtschump commented 2 months ago

That is right. Thanks for pointing this out to me.

Commit https://github.com/GreycLab/gmic/commit/7f75b4658b6ff22121c9ebd3232f0e5aee7f9da2 fixes this, by adding a new section "Testing Features" on the Download page.

image

jamesrhester commented 2 months ago

That's perfect.