[wp-trac] [WordPress Trac] #56070: Use a consistent order of annotations in the test suite

WordPress Trac noreply at wordpress.org
Thu Sep 21 21:11:54 UTC 2023


#56070: Use a consistent order of annotations in the test suite
--------------------------------------+---------------------
 Reporter:  SergeyBiryukov            |       Owner:  (none)
     Type:  task (blessed)            |      Status:  new
 Priority:  normal                    |   Milestone:  6.4
Component:  Build/Test Tools          |     Version:
 Severity:  normal                    |  Resolution:
 Keywords:  has-patch has-unit-tests  |     Focuses:
--------------------------------------+---------------------

Comment (by flixos90):

 I would like to bring attention to this ticket as the lack of
 documentation on WordPress core's requirements for test annotations has
 been problematic in the past couple months, requiring further iterations
 on otherwise completed PRs, based on something that is not documented and
 therefore feels arbitrary.

 I would like to better understand where this ticket is at and what the
 next steps are. The format that @SergeyBiryukov outlined in the ticket
 description makes total sense to me, so I wonder what are we looking for:
 Are we still discussing whether that's the right format? Are we waiting to
 write a proposal? Update the documentation? Update all existing tests?

 From my perspective, the thing that is lacking here ''right now'' is
 documentation. Given that we already would like new PRs to provide more
 appropriate annotations on tests, we should document whatever is currently
 expected - even if the ticket still remains open for further discussion or
 work (documentation can still be updated again later if needed).

 https://make.wordpress.org/core/handbook/testing/automated-testing
 /writing-phpunit-tests/#annotations currently doesn't mention any of these
 requirements, and I think we cannot expect PR authors to be aware of or
 follow "unwritten" rules.

-- 
Ticket URL: <https://core.trac.wordpress.org/ticket/56070#comment:13>
WordPress Trac <https://core.trac.wordpress.org/>
WordPress publishing platform


More information about the wp-trac mailing list