Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[JOSS review] Some information missing #13

Closed
lorenzo-rovigatti opened this issue Sep 22, 2024 · 4 comments
Closed

[JOSS review] Some information missing #13

lorenzo-rovigatti opened this issue Sep 22, 2024 · 4 comments

Comments

@lorenzo-rovigatti
Copy link

Hi! This is an issue that's linked to the JOSS review

According to the JOSS guidelines, there should be clear guidelines for third parties wishing to

  1. Contribute to the software
  2. Report issues or problems with the software
  3. Seek support

As far as I can see these are all missing in the current version of the repo. My advice is to set up issue templates for n. 2, and to add to the README and/or to the docs some information about what people should do to contribute to your software.

@ptmerz
Copy link

ptmerz commented Sep 30, 2024

Other reviewer here. I'll note that https://blaugroup.github.io/RNMC/ does have a section which covers the three points listed above. I think this is technically sufficient to pass the JOSS requirement, but I agree with @lorenzo-rovigatti that having these things mirrored on the repo README would be valuable!

@espottesmith
Copy link
Collaborator

Good suggestion! We'll provide a briefer description of these points in the README

@espottesmith
Copy link
Collaborator

@lorenzo-rovigatti @ptmerz, please check the README now. If you're satisfied, I'll close this issue.

@lorenzo-rovigatti
Copy link
Author

I think that's enough to comply with JOSS's requirements. I close this one, thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants