Skip to content

Commit 1f15709

Browse files
authored
docs: Clarify --CREDITS-- section (GH-23215)
1 parent 2fc1ef2 commit 1f15709

1 file changed

Lines changed: 4 additions & 3 deletions

File tree

docs/source/miscellaneous/writing-tests.rst

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -596,9 +596,10 @@ Example 1 (full): :ref:`sample001.phpt`
596596
on the first line. If the test was part of a TestFest event, then # followed by the name of the
597597
event and the date (YYYY-MM-DD) on the second line.
598598

599-
**Required:** No. For newly created tests this section should no longer be included, as test
600-
authorship is already accurately tracked by Git. If multiple authors should be credited, the
601-
`Co-authored-by` tag in the commit message may be used.
599+
**Required:** No. For newly created tests the section should no longer be used for simple authorship
600+
claims or listing all contributors who edited the test; as it is already accurately tracked by Git.
601+
It may be used if more specific attribution is useful, for example to credit the original reporter
602+
of a bug or a contributor who is not credited via `Co-authored-by` tag.
602603

603604
**Format:** Name Email [Event]
604605

0 commit comments

Comments
 (0)