-
Notifications
You must be signed in to change notification settings - Fork 31
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Normalize Markdown headers #63
Comments
So there are a few issues with this request to my mind:
Changing every heading in a release to be a If you feel strongly about the style of the release content being different you can always edit it afterwards, but I'd humbly suggest you don't. Ideally git tags, change logs, and releases should all tell the same story. |
Though I'd argue that in an ideal world, normalizing headers so they're semantic is GitHub's problem, practically I think you're right. I'd also argue that what's really important as long as the headers are the same level in relation to each other the meaning is practically the same (i.e. it tells the same story), but I guess that doesn't matter given the problem with the HTML's semantics. So basically in conclusion, 👍 |
In my changelogs I usually use
##
for each release and###
for each section of the release, e.g.:However in a GitHub Release I usually adjust these headers so they're all top-level
#
s since it doesn't really make sense to have a third-level header when there's no second-level or top-level headers. I.e. I'd love a feature where the body of 1.0.1 was normalized to:The text was updated successfully, but these errors were encountered: