ConnorDonegan / geostan

Bayesian spatial analysis
https://connordonegan.github.io/geostan
Other
56 stars 5 forks source link

JOSS Review: Contributing guidelines #4

Closed wcjochem closed 1 year ago

wcjochem commented 1 year ago

Please add clear guidance for third parties wishing to 1) Contribute to the software 2) Report issues or problems with the software 3) Seek support.

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

ConnorDonegan commented 1 year ago

I'm now reading up on how to write a nice CONTRIBUTOR.md file (https://opensource.guide/building-community/), and I'm adding the following section to the paper:

User support and discussion

In addition to consulting the package website and vignettes (https://connordonegan.github.io/geostan), users are encouraged to engage with geostan through the package github page (https://github.com/connordonegan/geostan). The "Discussions" tab is the best place for users to seek support and ask questions. Any issues with the software or suggestions for new features may also be proposed there or on the "Issues" tab. Contributions to the software can also be proposed by making a pull request to the github page.

wcjochem commented 1 year ago

Thanks for addressing this. As noted in the JOSS thread, this information is most appropriate in the README (and website) or at least a link to the CONTRIBUTOR.md.

ConnorDonegan commented 1 year ago

Sounds good, thanks