mapbox/mapbox-gl-js

changelog formatting is inconsistent

Open

#9,069 opened on Dec 4, 2019

View on GitHub
 (2 comments) (0 reactions) (0 assignees)JavaScript (10,532 stars) (2,203 forks)batch import
good first issueneeds discussion :speech_balloon:workflow :nail_care:

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

Tech stack
None
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Understanding of markdown headings
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85
Research direction
Review the CHANGELOG.md file for inconsistent heading levels (e.g., compare lines for bug fixes). Standardize on a consistent pattern, such as using '###' for subheadings. Consider adding a test to enforce formatting consistency.