kutaslab / fitgrid

Multichannel event-related time-series regression modeling for EEG, MEG, and sensor array data
https://kutaslab.github.io/fitgrid
BSD 3-Clause "New" or "Revised" License
8 stars 4 forks source link

[JOSS] Contributing guidelines #200

Closed sappelhoff closed 3 years ago

sappelhoff commented 3 years ago

(related to openjournals/joss-reviews#3293)

In the docs I found that you "welcome field reports" from Windows users. Other than that however, I did not see documentation on:

I think that although some of these points may have an implicit answer (e.g., users should just ask on GitHub Issues), there is a benefit in spelling this out in a dedicated documentation.

I recommend to either create a CONTRIBUTING.md file at the root of the project, and linking to it from the docs and README, or to prepare a dedicated page in the docs, and link to it from the README (and the docs toc).

sappelhoff commented 3 years ago

PS: The developer notes should also contain information on how to run the complete test suite.

sappelhoff commented 3 years ago

Thanks, I think this has been well addressed.