ropensci / software-review

rOpenSci Software Peer Review.
292 stars 104 forks source link

Be more precise about what initial editor checks can contain #482

Closed maelle closed 3 years ago

maelle commented 3 years ago

Cf https://github.com/ropensci/dev_guide/issues/352

I assume the results of pkgcheck are produced prior to the editor filling this.

emilyriederer commented 3 years ago

I like this a lot! It did inspire one question on this part:

Contributing information: Is the documentation for contribution clear enough e.g. tokens for tests, playgrounds?

Is this something that we should recommend authors have in a specific spot? (e.g. a section in main README? a separate README-DEV?)

maelle commented 3 years ago

Is this something that we should recommend authors have in a specific spot? (e.g. a section in main README? a separate README-DEV?)

Very good point, I clarified https://github.com/ropensci/dev_guide/blob/b65f0ada562fd26ec66335b448337c46f1e3884c/maintenance_collaboration.Rmd#L33 pkgcheck itself has a check looking for that file.