Skip to content
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

Feature: default header to "# Changelog" #108

Closed
JoshuaKGoldberg opened this issue Dec 21, 2024 · 1 comment
Closed

Feature: default header to "# Changelog" #108

JoshuaKGoldberg opened this issue Dec 21, 2024 · 1 comment

Comments

@JoshuaKGoldberg
Copy link

https://github.com/release-it/conventional-changelog?tab=readme-ov-file#header mentions "header": "# Changelog" as a suggested option. Which strikes me as pretty reasonable.

Files should start with a generally high-level heading and increase the level no more than one at a time. Having a # h1 at the start is a pretty common setting.

Is there any reason not to default header to "# Changelog"?

If it helps, I'm coming over from JoshuaKGoldberg/create-typescript-app#915, working on setting up headings in packages based on https://www.w3.org/WAI/tutorials/page-structure/headings.

@webpro webpro closed this as completed in 6197330 Dec 23, 2024
@webpro
Copy link
Contributor

webpro commented Dec 23, 2024

Agreed! It's in v9.0.4 🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants