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

request: Add option to group commits by type in changelog for version command #763

Open
1 task done
MobiliteDev opened this issue Sep 25, 2024 · 3 comments
Open
1 task done

Comments

@MobiliteDev
Copy link

Is there an existing feature request for this?

  • I have searched the existing issues.

Command

melos version --[no-]group-commits

Description

I would like to propose an enhancement to the version command in Melos that improves the changelog generation by grouping commits by their type (e.g., fix, feat). The idea is to have a single header for each type, under which all related commits are grouped. This would improve the readability of the changelog by reducing clutter and providing a more organized summary of changes.

For example :

### Fixes
- corrected issue with API call (#123)
- resolved UI glitch on iOS (#124)

### Features
- added user authentication (#125)
- implemented dark mode support (#126)

Reasoning

This feature would make changelogs more user-friendly, especially for projects with a lot of commits, by presenting changes in a more structured and less redundant way.

Additional context and comments

No response

@spydon
Copy link
Collaborator

spydon commented Sep 25, 2024

Sounds like a good idea, would you be interested in developing it?

@MobiliteDev
Copy link
Author

Hello!

Thank you for your response. I'm definitely interested in contributing to the development of this feature. However, I want to be upfront that I haven't contributed to open-source projects before, so I'm not entirely familiar with all the processes and best practices involved. That said, I'm eager to learn and follow any guidelines necessary to ensure my contribution meets the project's standards.

If you have any pointers or specific steps to follow, I'd greatly appreciate your guidance.

@spydon
Copy link
Collaborator

spydon commented Sep 26, 2024

We have a contributors guide here that you can read: https://github.com/invertase/melos/blob/main/CONTRIBUTING.md :)

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

No branches or pull requests

2 participants