search

ropensci / software-review

rOpenSci Software Peer Review.
291 stars 104 forks source link

Clarify what to write in NEWS.md #468

Closed maurolepore closed 2 years ago

maurolepore commented 2 years ago

This PR aims to clarify what authors should write in NEWS.md.

I note our request deviates from https://style.tidyverse.org/news.html -- which focuses only on changes that face users -- and from the practice of documenting changes after the first public release.

However, our approach is nice in that it leaves a record of the peer-review that is more discoverable and readable than the scattered comments in the review issue, where authors tell reviewers how they addressed their requests.

I plan to follow up with a PR to the template in Spanish, but to avoid working on a moving target, I suggest we discuss this PR first. 

maurolepore commented 2 years ago

@maelle,

Do we expect the bot to start using the latest version of this template automatically?

It seems the changes introduced in this PR are NOT reflected in a issue-comment:

Please check you updated the package version post-review version updated and that you documented all changes in NEWS.md

maelle commented 2 years ago

@xuanxu is there some caching in the template fetching? We edited the template 28 days ago but a comment from 2 days ago seems to have used the old version.

xuanxu commented 2 years ago

That comment was not made by the review bot, maybe the editor copied from somewhere else?

maelle commented 2 years ago

oooh right, good call, thank you and sorry!