JOSS review: Recommended edits to README #4

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.

Sign up for GitHub

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

Jump to bottom

Closed

kanishkan91 opened this issue Jun 4, 2023 · 1 comment

kanishkan91 commented Jun 4, 2023 •

edited

Loading

I would recommend adding a short summary of what the package does in the README. You can use what you wrote for the paper directly.
Could the author also add a "Contribution instructions" section so that the users would know who to reach out to in case of issues. Author would just need to mention an email ID and encourage users to open issues.

openjournals/joss-reviews#5434

maximelenormand added a commit that referenced this issue


          Update README (#4), DESCRIPTION (#10) and vignettes (#11)

f3f4f6f

Member

maximelenormand commented Jun 5, 2023

I added a "Short description" and "Contribution instructions" in the README. Thank you for the suggestions.

maximelenormand closed this as completed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment