keep-a-changelog icon indicating copy to clipboard operation
keep-a-changelog copied to clipboard

Separators between version number and release date

Open yudai-nkt opened this issue 7 years ago • 5 comments

This might be a possible duplicate of #59, but I have a question about what should be used between version number and release date.

There are several hyphen-shaped characters in Unicode, e.g.,

  • ‐ (U+2010 HYPHEN)
  • – (U+2013 EN DASH), or – for the sake of typing ease in HTML
  • — (U+2014 EM DASH), or —

and each has its own role. An excerpt from Oxford Dictionaries says

Hyphens are used to link words and parts of words. They are not as common today as they used to be, but there are three main cases where you should use them:

  • in compound words
  • to join prefixes to other words
  • to show word breaks

and neither of these seems to apply for hyphen usage here. Another excerpt says

An em dash, or long dash, is used:

  • [...]
  • to show other kinds of break in a sentence where a comma, semicolon, or colon would be traditionally used:

and this is the case I think separators fall under. So should the hyphens be replaced by em dash (or possibly en dash)?

Since I'm not an expert of English, I can't say using hyphens is typographically incorrect. That being said, I would say hyphen looks weird IMHO and this would be worth discussing to make Keep a Changelog better and more human-readable.

yudai-nkt avatar Aug 22 '17 16:08 yudai-nkt

FWIW, this is how release heading changes:

1.0.0 - 2017-06-20

1.0.0—2017-06-20

yudai-nkt avatar Aug 22 '17 16:08 yudai-nkt

I'd say the main reason it's common to use a simple ascii - over a Unicode char is to support text editors and terminals that don't support Unicode (though there are not many these days). Also the difference is much more subtle in a fixed-width font, so the value it adds is minimal (- vs ).

obosob avatar Sep 25 '17 11:09 obosob

Also n-dash and m-dash are difficult to type. What are our options? —? Alt + 0151 on Windows? Ctrl+Shift+U+2014 on Linux? IMO this would be solved only if common Markdown began to accept -- and --- as n-dash and m-dash (see https://github.com/github/markup/issues/77 , for example).

brauliobz avatar Sep 25 '17 13:09 brauliobz

Character entity references such as – or — are easy enough to type for me, but it doesn't seem to be the case for everyone...

Also the difference is much more subtle in a fixed-width font

Yes, but I think it's unlikely for Markdown files to be rendered in mono-spaced fonts unless we use such CSS stylesheets.

yudai-nkt avatar Sep 28 '17 07:09 yudai-nkt

An alternative is to inverse the fields and use ':'. This would give YYYY-MM-DD : version. See also https://github.com/olivierlacan/keep-a-changelog/issues/59#issuecomment-538630017

axd1967 avatar Oct 05 '19 08:10 axd1967