Skip to content

Credit reviewer in what's new contributions. #4705

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Apr 29, 2022
Merged

Credit reviewer in what's new contributions. #4705

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
68c16e2
Credit reviewer in what's new contributions.
trexfeathers Apr 22, 2022
9329ec4
Correct example link in what's new docs.
trexfeathers Apr 25, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions docs/src/developers_guide/documenting/whats_new_contributions.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,9 @@ The required content, in order, is as follows:
user name. Link the name to their GitHub profile. E.g.
```@tkknight <https://github.com/tkknight>`_ changed...``

* Bigger changes take a lot of effort to review, too! Make sure you credit
the reviewer(s) where appropriate.

* The new/changed behaviour

* Context to the change. Possible examples include: what this fixes, why
Expand All @@ -82,8 +85,9 @@ The required content, in order, is as follows:

For example::

#. `@tkknight <https://github.com/tkknight>`_ changed changed argument ``x``
to be optional in :class:`~iris.module.class` and
#. `@tkknight <https://github.com/tkknight>`_ and
`@trexfeathers <https://github.com/trexfeathers>`_ (reviewer) changed
argument ``x`` to be optional in :class:`~iris.module.class` and
:meth:`iris.module.method`. This allows greater flexibility as requested in
:issue:`9999`. (:pull:`1111`, :pull:`9999`)

Expand Down