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

[CHORE]: keep a changelog format update for GitHub auto indexing #312

Open
fugerit79 opened this issue Mar 12, 2025 · 0 comments
Open

[CHORE]: keep a changelog format update for GitHub auto indexing #312

fugerit79 opened this issue Mar 12, 2025 · 0 comments
Assignees

Comments

@fugerit79
Copy link
Member

fugerit79 commented Mar 12, 2025

Module

Changelog

Expected Behavior

We only want the only show versions in GitHub auto indexing

Other information

As stated in :
https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#headings

Currently all headers are indexed by default on GitHub, we want to switch from header for subsection :

### Changed

To bold :

**Changed**

And the GitHub auto index would change from

Image

to

Image

NOTE : this is to be considered an optional alternate changelog formatting proposal

NOTE : in case the proposal is accpeted maybe a complementary migration guide could be proposed

@fugerit79 fugerit79 self-assigned this Mar 12, 2025
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

When branches are created from issues, their pull requests are automatically linked.

1 participant