indexmap-rs / indexmap

A hash table with consistent order and fast iteration; access items by key or sequence index
https://docs.rs/indexmap/
Other
1.71k stars 150 forks source link

Releases: Adjust markdown format #306

Closed Turbo87 closed 9 months ago

Turbo87 commented 9 months ago

When services like https://github.com/renovatebot/renovate open dependency update pull requests they try to find a corresponding changelog entry to let the developers know what changes this dependency update includes.

The current format of the RELEASES.md file with its nested lists appears to be uncommon enough to not get recognized by at least renovatebot.

This changes the format to use h2 elements for the versions, which should allow renovatebot to pick up the contents and generally renders in a slightly nicer way :D

Best reviewed in "ignore whitespace" mode: https://github.com/indexmap-rs/indexmap/pull/306/files?w=1 😉

/cc @cuviper

cuviper commented 9 months ago

Sounds good, thanks!