search

schochastics / signnet

R package for signed networks
https://schochastics.github.io/signnet/
Other
22 stars 6 forks source link

Add and extend contributing guidelines to README.md #13

Closed cosimameyer closed 1 year ago

cosimameyer commented 1 year ago

Specific ontributor guidelines exist on the package's website. Making them also transparent in your GitHub README.md would be fantastic (I think most people will use the GitHub repository as the landing page to explore more information on the package and there's currently only a general "Code of Conduct" that does not address where to address how to explicitly "1) Contribute to the software 2) Report issues or problems with the software 3) Seek support").

Similarly, making clear how to seek support (for instance, by opening an issue) would provide (new) users with good guidance. It's a suggestion, but we added it to our package README this way throughout the review process at JOSS and I think it was a good suggestion by our reviewer.

(This issue is part of the review https://github.com/openjournals/joss-reviews/issues/4987)

schochastics commented 1 year ago

I like what you did there. Hope you dont mind me copy pasting this :)