search

openlawlibrary / pygls

A pythonic generic language server
https://pygls.readthedocs.io/en/latest/
Apache License 2.0
568 stars 103 forks source link

Inconsistent date formats in changelog #300

Closed perrinjerome closed 11 months ago

perrinjerome commented 1 year ago

Recent entries are in D/MM/YYYY format:

https://github.com/openlawlibrary/pygls/blob/24fe1f080995b8af592964f9f81866bac93bac34/CHANGELOG.md?plain=1#L13

Older entries were in MM/DD/YYYY format

https://github.com/openlawlibrary/pygls/blob/24fe1f080995b8af592964f9f81866bac93bac34/CHANGELOG.md?plain=1#L306

From CHANGELOG.md:

https://github.com/openlawlibrary/pygls/blob/24fe1f080995b8af592964f9f81866bac93bac34/CHANGELOG.md?plain=1#L5

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 1 year ago

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.

tombh commented 11 months ago

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