qpv-research-group / rayflare

Open-source, integrated optical modelling of complex stacks
Other
31 stars 11 forks source link

[JOSS] add community guidelines #29

Closed kandersolar closed 2 years ago

kandersolar commented 2 years ago

One of the JOSS review items is:

Community guidelines: Are there clear guidelines for third parties wishing to 1) Contribute to the software 2) Report issues or problems with the software 3) Seek support

I don't think any of these three points are explicitly addressed (though maybe I missed it!). Some packages include this sort of info in the GitHub README or as a page in their sphinx docs. GitHub also has a feature for this that might be useful, see "Contributing" here: https://github.com/qpv-research-group/rayflare/community

xref https://github.com/openjournals/joss-reviews/issues/3460

phoebe-p commented 2 years ago

To-do list for my own use:

phoebe-p commented 2 years ago

@kanderso-nrel I think I have now covered all these things in PR #33, now merged into devel.

kandersolar commented 2 years ago

I agree, feel free to close!