search

mapbox / mapbox-gl-js

Interactive, thoroughly customizable maps in the browser, powered by vector tiles and WebGL
https://docs.mapbox.com/mapbox-gl-js/
Other
11.23k stars 2.23k forks source link

changelog formatting is inconsistent #9069

Open ansis opened 4 years ago

ansis commented 4 years ago

The number of # used for subheadings changes. Compare: https://github.com/mapbox/mapbox-gl-js/blob/254674eecba53a275a77599fdac8908f9900c350/CHANGELOG.md#-bug-fixes-1 https://github.com/mapbox/mapbox-gl-js/blob/254674eecba53a275a77599fdac8908f9900c350/CHANGELOG.md#-bug-fixes-5

### is better?

Should we add a test for this?

chloekraw commented 4 years ago

At one point, we also added the release date to the heading at the top which included the version, which I like: https://github.com/mapbox/mapbox-gl-js/blob/254674eecba53a275a77599fdac8908f9900c350/CHANGELOG.md#0430-december-21-2017

Sticking to this format from the 0.43.0 release is my preference.

## x.x.x (month day, year)
### Features 
### Improvements
### Bug fixes
andrewharvey commented 4 years ago

also in the recent 1.6.0 some h/t's are @ links others are just [] links which is inconsistent.

I think ### is better as they are subheadings of the version number which is ##.

It's nice to have the date in there too, but I'm not too fussed either way.