Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

State the date format explicitly #366

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

State the date format explicitly #366

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

This changlog uses the [ISO 8601 date format](https://www.iso.org/iso-8601-date-and-time-format.html) of (YYYY-MM-DD).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is a typo: changlog instead of changelog.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@sean-hut ^

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I personally learned more. The RFC 3339 defines a profile for ISO 8601.

I would propose:

This changelog uses the `full-date` format of [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339#section-5.6), which is `YYYY-MM-DD`.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@koppor while your proposal would be technically more precise, I feel it's an overkill due to unnecessary complexity.

Just open your referenced link. Does one really need to know all these semantics to understand that a date (a "full date" that is) is represented as simple as YYYY-MM-DD?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shorter version (no need to mention "the changelog" & highlight the format:

Suggested change
This changlog uses the [ISO 8601 date format](https://www.iso.org/iso-8601-date-and-time-format.html) of (YYYY-MM-DD).
Dates use the [ISO 8601 date format](https://www.iso.org/iso-8601-date-and-time-format.html) of `YYYY-MM-DD`.


## [Unreleased]

Copy link
Contributor

@ravage84 ravage84 Jun 2, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agree with @koppor , it should get a change log entry.

Suggested change
### Added
- Mention use of [ISO 8601 date format](https://www.iso.org/iso-8601-date-and-time-format.html) (`YYYY-MM-DD`).

## [1.1.0] - 2019-02-15
Expand Down