Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Latest "What's New"s need PR links #3818

Closed
trexfeathers opened this issue Sep 7, 2020 · 6 comments
Closed

Latest "What's New"s need PR links #3818

trexfeathers opened this issue Sep 7, 2020 · 6 comments
Assignees
Milestone

Comments

@trexfeathers
Copy link
Contributor

📚 Documentation

Following #3816 (comment), 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..."

@bjlittle
Copy link
Member

bjlittle commented Sep 9, 2020

@trexfeathers Would it be possible to also include the following under this task:

  • Add the associated GitHub author that contributed to delivering the content of the whatsnew, if possible
  • Update the documentation to state that, apart from referencing the relevant issues/pull-request of a whatsnew entry, the GitHub author is also referenced and cited.

@trexfeathers
Copy link
Contributor Author

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".

@bjlittle
Copy link
Member

bjlittle commented Sep 10, 2020

@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 🤔

@trexfeathers
Copy link
Contributor Author

trexfeathers commented Sep 10, 2020

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")

@bjlittle
Copy link
Member

bjlittle commented Sep 10, 2020

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 🚀

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`)

@trexfeathers
Copy link
Contributor Author

Closed by #3838

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants