openlawlibrary/pygls

Inconsistent date formats in changelog

Closed this issue · 2 comments

Recent entries are in D/MM/YYYY format:

## [1.0.0] - 2/12/2022

Older entries were in MM/DD/YYYY format

## 0.7.2 - 12/28/2018

From CHANGELOG.md:

The format is based on [Keep a Changelog][keepachangelog],

Keep a Changelog recommends YYYY-MM-DD format.

Confusing Dates

Regional date formats vary throughout the world and it's often difficult to find a human-friendly date format that feels intuitive to everyone. The advantage of dates formatted like 2017-07-17 is that they follow the order of largest to smallest units: year, month, and day.

maybe it would be better to switch to YYYY-MM-DD ?

tombh commented

I'd like to propose that Pygls starts using an automatic CHANGELOG generator, such as https://github.com/orhun/git-cliff. And that we require Conventional Commits messages. The CHANGELOG file doesn't have to be auto-populated in CI, although I would like to try that at first. More than anything I would just like it to be populated by a standard tool and we could edit it after the auto-population.

This was fixed in #349 by automating with https://github.com/orhun/git-cliff