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

[WordPress Trac]

#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 dev-feedback  |     Focuses:
---------------------------------------------------+---------------------

Comment (by jrf):

 > 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

 @flixos90 why was this problematic ? why did this cause iterations on PRs
 ?
 As there is no standard, there is nothing to enforce, other than the
 committers personal preference (at this time).

 > what the next steps are

 As formalizing an order requires a change to the
 [https://developer.wordpress.org/coding-standards/inline-documentation-
 standards/php/ coding standards handbook], the next step would be a
 proposal via a Make post.

 Having said that, I don't think we're ready for that yet as there was
 never any response to the feedback already given in this ticket. I believe
 those remarks should be addressed first.

 > Is it possible that we could decide this within this ticket? I don't
 think this is something that is likely to garner much feedback or many
 iterations via a Make/Core post beyond what's already been shared in this
 ticket.

 @costdev No, it can't. It has been made very clear to me and others at
 various points in time, that no matter how innocent the change, coding
 standards changes MUST go via a proposal on Make.
 I see no reason why this proposal would be exempt from that rule.
 If there's not much feedback/push-back, all the better as that means that
 the proposal can move forward reasonably quickly after the post has been
 published.


 Process-wise, in my view, the steps are:
 * Get some form of agreement on the format to propose from the current
 stakeholders (people involved in this ticket).
 * Write & publish a Make post proposing an addition/update to the Coding
 Standards handbook.
 * If approved/there are no objections: submit a PR to the Coding Standards
 handbook repo & get that merged.
 * Update the code samples in the test handbook where necessary to comply
 with the new rules + add links to the Coding Standards which apply
 (possibly more updates are needed, this would need to be evaluated at that
 time).
 * Open a feature request ticket in the WordPressCS repo for enforcement of
 the new rules (may be a while before that gets addressed).
 * Green light for updating existing tests.

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