ringbp icon indicating copy to clipboard operation
ringbp copied to clipboard

mention PR authors / reviewers in NEWS.md

Open sbfnk opened this issue 11 months ago • 4 comments

We dropped this in EpiNow2 because it became a bit of a pain to maintain, and it's not really useful information to the user. Using allcontributors in the README mitigates some of the issue with attributing credit.

I'd suggest to remove mentions of authors, reviewers and PR numbers from the NEWS file.

sbfnk avatar May 09 '25 11:05 sbfnk

I personally don't have a preference. Mentioning authors and reviewers in the NEWS.md give more granularity to contributions than allcontributors, but I've not consistently used this style of news bullets so if you've found from {EpiNow2} it's a bit cumbersome then I'm happy to revert.

On other GH organisations I've worked on, the default is always mention PR number and mention GH handle if contributor is external. This seems to closely mirror the tidyverse style:

If the bullet is related to an issue, include the issue number. If the contribution is a PR, and the author is not a package author, include the GitHub user name.

joshwlambert avatar May 09 '25 11:05 joshwlambert

That sounds really sensible. I would prefer to mention Issue number (as in the tidyverse quote) over PR number as that's known at the time of composing the PR.

sbfnk avatar May 09 '25 12:05 sbfnk

Sounds reasonable - codify in CONTRIBUTING.md or some such?

pearsonca avatar May 09 '25 12:05 pearsonca

Not sure why but I've changed my preference on the NEWS.md. I now prefer the current setup of

[change description] "Addresses" [issue no.] "by" [GitHub username] "in" [PR no.] "and reviewed by" [GitHub username(s)]

Apologies for being contrarian, I'm fine being outvoted on this and can implement either this or the tidyverse approach in a CONTRIBUTING.md once decided.

joshwlambert avatar Sep 25 '25 15:09 joshwlambert