@@ -53,8 +53,8 @@ merge from trunk.
5353Writing a Contribution
5454======================
5555
56- As introduced above, a contribution is the description of a change to Iris
57- which improved Iris in some way. As such, a single Iris Pull Request may
56+ A contribution is the short description of a change introduced to Iris
57+ which improved it in some way. As such, a single Iris Pull Request may
5858contain multiple changes that are worth highlighting as contributions to the
5959what's new document.
6060
@@ -67,23 +67,31 @@ exceed **column 80** and ensure that any subsequent lines of the same entry are
6767aligned with the first. The content should target an Iris user as the audience.
6868The required content, in order, is as follows:
6969
70- * Names of those who contributed the change. These should be their GitHub
71- user name. Link the name to their GitHub profile. E.g.
72- ```@tkknight <https://github.com/tkknight>`_ changed... ``
70+ * Use your discretion to decide on the names of all those that you want to
71+ acknowledge as part of your contribution. Also consider the efforts of the
72+ reviewer. Please use GitHub user names that link to their GitHub profile
73+ e.g.,
7374
74- * Bigger changes take a lot of effort to review, too! Make sure you credit
75- the reviewer(s) where appropriate.
75+ ```@tkknight`_ Lorem ipsum dolor sit amet ... ``
7676
77- * The new/changed behaviour
77+ Also add a full reference in the following section at the end of the ``latest.rst ``::
78+
79+ .. comment
80+ Whatsnew author names (@github name) in alphabetical order. Note that,
81+ core dev names are automatically included by the common_links.inc:
82+
83+ .. _@tkknight: https://github.com/tkknight
84+
85+ * A succinct summary of the new/changed behaviour.
7886
7987* Context to the change. Possible examples include: what this fixes, why
8088 something was added, issue references (e.g. ``:issue:`9999` ``), more specific
8189 detail on the change itself.
8290
83- * Pull request references, bracketed, following the final period. E .g.
91+ * Pull request references, bracketed, following the final period e .g.,
8492 ``(:pull:`1111`, :pull:`9999`) ``
8593
86- * A trailing blank line (standard reStructuredText list format)
94+ * A trailing blank line (standard reStructuredText list format).
8795
8896For example::
8997
0 commit comments