[DRIVERS-2463] Use consistent ordering for changelog entries Created: 06/Oct/22  Updated: 11/Oct/22

Status: Backlog
Project: Drivers
Component/s: None
Fix Version/s: None

Type: Task Priority: Unknown
Reporter: Jeremy Mikola Assignee: Unassigned
Resolution: Unresolved Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Related
is related to DRIVERS-2253 Remove spec versions and front matter Closed
Driver Changes: Not Needed

 Description   

Summary

In DRIVERS-2253, I converted most spec changelogs to use Field Lists. I found that specs are inconsistent in how they order changelog entries (ascending vs. descending). There were numerous cases where changelog entries were out of order, which I addressed in my PR; however, I did not re-order changelogs across the board.

I think it'd be worthwhile to standardize on an order, and stick with that going forward.

Motivation

Who is the affected end user?

Spec editors.

How does this affect the end user?

From time to time, changelog updates are entered out of order. These errors are frequently missed during PR review and end up being corrected in future PRs (if at all).

Is this issue urgent?

No.

Is this ticket required by a downstream team?

No.

Is this ticket only for tests?

No.



 Comments   
Comment by Jeremy Mikola [ 06/Oct/22 ]

The decision between ascending and descending is probably arbitrary, but I'll start the conversation by suggesting we standardize on an ascending order. This will ensure new entries are always appended to the bottom of a changelog, and that will require editors to look at existing entries before adding their own to the list. This may subtly help editors catch inconsistencies before adding an entry (e.g. missing a leading zero in YYYY-MM-DD date, not wrapping text correctly).

Generated at Thu Feb 08 08:25:39 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.