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

Remove commit types from subjects in CHANGELOG #924

Open
paduszyk opened this issue May 10, 2024 · 2 comments
Open

Remove commit types from subjects in CHANGELOG #924

paduszyk opened this issue May 10, 2024 · 2 comments
Labels
confirmed Prevent from becoming stale feature A new feature or a feature request

Comments

@paduszyk
Copy link

Description

Hey βœ‹πŸ» First of all, thanks for such a great project! πŸ’š

Changelog summarizes changes grouped by types - in the case of the Angular scheme, the type is simply the semantic prefix of the message: ci, chore, feat, etc. Within the given type, all the commits are listed with the prefix repeated, like that:

> ### Fix
> * fix: resolve hofix 
> * fix: fix another bug

so, the prefix is repeated for each commit. I think that removing commit types (and capitalizing the subject) would result in a cleaner CHANGELOG:

> ### Fix
> * Resolve hofix
> * Fix another bug

Use cases

Removing prefixes will reduce redundancy.

Possible implementation

This issue is to share my idea. I don't know how to implement it, I haven't dug into the codebase yet...

@paduszyk paduszyk added the feature A new feature or a feature request label May 10, 2024
@codejedi365
Copy link
Contributor

@paduszyk Thanks for the report, I am working this effort it's just taken me some time to make it public in lieu of other priorities. There is a milestone for improved changelogs that I'm consolidating all of them. Feel free to check out what is planned and add what you would like to see as well.

@codejedi365 codejedi365 added this to the Better Changelogs milestone May 10, 2024
@codejedi365 codejedi365 added the confirmed Prevent from becoming stale label May 10, 2024
@codejedi365
Copy link
Contributor

@paduszyk, one thing I forgot to mention is that if you wanted to see this resolved in your own projects today, you can easily define your own custom changelog template and apply it to your projects.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
confirmed Prevent from becoming stale feature A new feature or a feature request
Projects
None yet
Development

No branches or pull requests

2 participants