ropensci / software-review-meta

For organizing projects related to rOpenSci Software Peer Review
10 stars 3 forks source link

Updating the template #68

Closed karthik closed 5 years ago

karthik commented 5 years ago

Our template is quite out of date and can be immediately updated without waiting for any complex forms + integrations. Right now the critical bits of information are buried below. At the top we could have:

URL of software repo
Name of submitter
version 
editor
etc

image

And compare with JOSS for example where all the key bits are at the top:

image

Also see #52

cboettig commented 5 years ago

This is great.

A few other comments as a user of this form. I struggle to answer the "category" question every time because there is not a list of possible categories right there. (The link provided in the template now just brings you to page pointing to the developer guide, and this information isn't obviously located in the guide.) Ideally I think the template should just provide a set of check boxes listing possible categories (followed by a prompt to provide a justification, with the nice example justifications included).

Much more minor, but several of the other prompts seem to duplicate information that is (or at least should be) in the copy-pasted DESCRIPTION (e.g. package description). But maybe this is good redundancy.

karthik commented 5 years ago

Thanks @cboettig. This is very helpful.

Can you take a look at this version and see if it is better: https://github.com/ropensci/onboarding/blob/template-fix/issue_template.md

cc @sckott @noamross @maelle

karthik commented 5 years ago

Also here is the PR for this: https://github.com/ropensci/onboarding/pull/268

cboettig commented 5 years ago

New template looks great! The check-boxes for scope question are a huge help. ✨

Just a few further thoughts.

There are a few relatively routine checks we have for editors and reviewers that are not things we tell authors to do in the initial check-list -- for instance, I have 50/50 odds of forgetting to include a CONTRIBUTING.md until a reviewer points that out from the reviewer checklist. I know goodpractice can be tricky for some users to get running locally, but it's another possible thing to mention to the authors ahead of time.

karthik commented 5 years ago

New template has been merged. Thanks for these comments, Carl. In the next update we'll work to deep link into the dev guide. 🙏 .