changelog formatting is inconsistent
Open
good first issue
needs discussion :speech_balloon:
workflow :nail_care:
- Dominant language
- TypeScript
- Stars
- 12.4k
- Forks
- 2.4k
- PR merge metrics
- No merged PRs in 30d
Description
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?
Contributor guide
Research direction
Start with CHANGELOG.md and compare the two linked “Bug fixes” sections. Determine the intended heading level for changelog subheadings, then make the formatting consistent and assess whether the changelog structure should have a test.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100