From 68c16e25d1ec76ecb41bfbb2ab1f25fa41cd83b0 Mon Sep 17 00:00:00 2001 From: Martin Yeo Date: Fri, 22 Apr 2022 12:11:18 +0100 Subject: [PATCH 1/2] Credit reviewer in what's new contributions. --- .../documenting/whats_new_contributions.rst | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/docs/src/developers_guide/documenting/whats_new_contributions.rst b/docs/src/developers_guide/documenting/whats_new_contributions.rst index c9dbe04b71..c10f53ade7 100644 --- a/docs/src/developers_guide/documenting/whats_new_contributions.rst +++ b/docs/src/developers_guide/documenting/whats_new_contributions.rst @@ -69,6 +69,9 @@ The required content, in order, is as follows: user name. Link the name to their GitHub profile. E.g. ```@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 @@ -82,8 +85,9 @@ The required content, in order, is as follows: For example:: - #. `@tkknight `_ changed changed argument ``x`` - to be optional in :class:`~iris.module.class` and + #. `@tkknight `_ and + `@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`) From 9329ec45ba9062135ddead9a82e54fa9a212ee83 Mon Sep 17 00:00:00 2001 From: Martin Yeo <40734014+trexfeathers@users.noreply.github.com> Date: Mon, 25 Apr 2022 10:15:34 +0100 Subject: [PATCH 2/2] Correct example link in what's new docs. Co-authored-by: Will Benfold <69585101+wjbenfold@users.noreply.github.com> --- .../developers_guide/documenting/whats_new_contributions.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/src/developers_guide/documenting/whats_new_contributions.rst b/docs/src/developers_guide/documenting/whats_new_contributions.rst index c10f53ade7..1a820ab24e 100644 --- a/docs/src/developers_guide/documenting/whats_new_contributions.rst +++ b/docs/src/developers_guide/documenting/whats_new_contributions.rst @@ -86,7 +86,7 @@ The required content, in order, is as follows: For example:: #. `@tkknight `_ and - `@trexfeathers <`_ (reviewer) changed + `@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`)