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

Add header links in changelogs #2241

Closed
wants to merge 1 commit into from
Closed

Add header links in changelogs #2241

wants to merge 1 commit into from

Conversation

Goooler
Copy link
Member

@Goooler Goooler commented Aug 28, 2024

Follow up #2196.

image

@Goooler
Copy link
Member Author

Goooler commented Aug 28, 2024

@nedtwigg I guess this should be covered from com.diffplug.spotless-changelog side. A bug or a new feature?

@nedtwigg
Copy link
Member

What functionality do these Changelog things have that this URL does not?

My view is that CHANGELOG.md should be as simple as possible, and other tools like e.g. GitHub releases can make it "richer", but I don't think we need to pull that complexity into the changelog itself.

@Goooler
Copy link
Member Author

Goooler commented Aug 29, 2024

These links point to the releases on GitHub Web, if we don't need them, should keep the formats like ## 3.0.0.BETA2 - 2024-08-25 instead of #[3.0.0.BETA2] - 2024-08-25.

@nedtwigg
Copy link
Member

I'm following this convention: https://keepachangelog.com/en/1.1.0/

@Goooler
Copy link
Member Author

Goooler commented Aug 30, 2024

Yeah, I noticed. But header links are used in this convention for displaying links in titles and keep the format concise, like this:

image

We don't have these links, therefore [] looks redundant. But anyway, such a small thing.

@nedtwigg nedtwigg closed this Aug 30, 2024
@Goooler Goooler deleted the g/add-header-links branch August 30, 2024 15:12
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

Successfully merging this pull request may close these issues.

2 participants