elliohow / fMRI_ROI_Analysis_Tool

An analysis tool that uses per-voxel statistical maps in conjunction with FSL atlases to create per-region statistical maps. Current usage includes the creation of regional maps of temporal signal to noise ratio.
Apache License 2.0
11 stars 4 forks source link

[JOSS Review] Community guidelines #39

Closed billbrod closed 1 year ago

billbrod commented 1 year ago

Instructions for opening an issue or getting help are present, but there's nothing for how to contribute. I would like to see a code of conduct and contributing guide. Here's a template from the Turing Way, and some examples: matplotlib, nipype

https://github.com/openjournals/joss-reviews/issues/5200

billbrod commented 1 year ago

It's not necessary, but the discussion in #35 reminded me: it might be useful to define a bug report issue template that will prompt users for a lot of the basic information: what fRAT version, what FSL version, what python version, attach a screenshot or pasted version of the terminal output ,etc.

elliohow commented 1 year ago

There is already a contributing with development section in the documentation and on the github readme, is this sufficient?

billbrod commented 1 year ago

I think that's a good start, but I think a code of conduct (you can lightly adapt this one) is necessary.

And, while not necessary, the following would be nice to add to the contributing section: what kind of contributions you're interested and uninterested in (more documentation, examples, new features, integration with other tools, etc.), any info about coding style or API, and required documentation and/or tests. Basically, what should they include in the PR? E.g., a description of what it includes, a small working example, the need it fills, etc.

billbrod commented 1 year ago

Some guidance on codes of conduct and contributor guidelines from Mozilla's open leadership program.

elliohow commented 1 year ago

I've added a code of conduct, contributing guidelines and issue templates, and linked to them in the documentation.

billbrod commented 1 year ago

This looks good!