JOSS asks for clear guidance on contributing, reporting problems, and seeking support. The
repository has no CONTRIBUTING.md, no CODE_OF_CONDUCT.md, and no issue templates.
BugReports: in DESCRIPTION points at the tracker, which covers part of the second point but not
the other two.
usethis::use_tidy_contributing() and usethis::use_code_of_conduct() generate reasonable
starting points. Worth saying explicitly in CONTRIBUTING.md: whether you want PRs against main,
whether contributors should run devtools::document() themselves, and where to ask usage questions
as opposed to filing bugs.
This is part of the review at openjournals/joss-reviews#11209
JOSS asks for clear guidance on contributing, reporting problems, and seeking support. The
repository has no
CONTRIBUTING.md, noCODE_OF_CONDUCT.md, and no issue templates.BugReports:in DESCRIPTION points at the tracker, which covers part of the second point but notthe other two.
usethis::use_tidy_contributing()andusethis::use_code_of_conduct()generate reasonablestarting points. Worth saying explicitly in
CONTRIBUTING.md: whether you want PRs againstmain,whether contributors should run
devtools::document()themselves, and where to ask usage questionsas opposed to filing bugs.
This is part of the review at openjournals/joss-reviews#11209