ropensci / software-review-meta

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

Should new review issue instructions specify to change the "Name" field? #101

Open mikemahoney218 opened 3 months ago

mikemahoney218 commented 3 months ago

The top of a new review issue reads:

Below, please enter values for (1) submitting author GitHub handle (replacing "@github_handle@); and (2) Repository URL (replacing "https://repourl"). Values for additional package authors may also be specified, replacing "@github_handle1", "@github_handle2" - delete these if not needed. DO NOT DELETE HTML SYMBOLS (everything between "<!" and ">"). Replace only "@github_handle" and "https://repourl". This comment may be deleted once it has been read and understood.

The first field though is:

Submitting Author Name: Name

Which isn't mentioned as one of the values to change. Should this read:

Below, please enter values for (1) submitting author name (replacing "Name"); (2) submitting author GitHub handle (replacing "@github_handle@); and (3) Repository URL (replacing "https://repourl"). Values for additional package authors may also be specified, replacing "@github_handle1", "@github_handle2" - delete these if not needed. DO NOT DELETE HTML SYMBOLS (everything between "<!" and ">"). Replace only "Name", "@github_handle", and "https://repourl". This comment may be deleted once it has been read and understood.

Skimming over the last few issues, it seems like I was the only person tripped up by this -- I think I'm too much of a rules follower! :laughing: