Following https://github.com/SciTools/iris/pull/3816#discussion_r484087699, as many entries as possible in docs/iris/src/whatsnew/latest.rst should have links added to the associated Iris PR(s). It might also be wise to make the documentation note about adding such links a bit more insistent than the current "optionally you may also include..."
@trexfeathers Would it be possible to also include the following under this task:
whatsnew, if possiblewhatsnew entry, the GitHub author is also referenced and cited.Add the associated GitHub author that contributed to delivering the content of the whatsnew
@bjlittle 馃憤馃憤馃憤 great idea! This was actually discussed at SciPy 2020 as an important thing to do for healthy open source communities, and I notice it's already happening in Cartopy's "What's New".
@trexfeathers Cool!
Also, with regards to referencing the associated PR... as a standard to follow do you think it's best to have something like:
* whatsnew contribution. See :pull:`3818`.
Or, akin to cartopy:
* whatsnew contribution. (:pull:`3818`)
I kinda like the latter 馃
I agree on the latter, which leaves us free to use See :pull: and other syntaxes for more specific extra detail ("for extra info go check this out")
I agree on the latter, which leaves us free to use
See :pull:and other syntaxes for more specific extra detail ("for extra info go check this out")
@trexfeathers Awesome. Let's go with that then :rocket:
I'm currently making some whatsnew entries in my cube-arithmetic-post feature branch, so I'll adopt that style also to save any follow-up re-work.
And I'm assuming that you're going with the same approach as cartopy for citing authors e.g.,
John Smith contributed blah. (:pull:`xxxx`)
Closed by #3838