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

Support for sorting PRs by the title #323

Closed
ryamaguchi0220 opened this issue Nov 11, 2019 · 5 comments · Fixed by #324
Closed

Support for sorting PRs by the title #323

ryamaguchi0220 opened this issue Nov 11, 2019 · 5 comments · Fixed by #324

Comments

@ryamaguchi0220
Copy link
Contributor

In my use case, I'd like to sort PRs by title instead of merged_at.
I think it makes sense to add a sort-by option that accepts either title or merged_at so that users can decide for themselves what they like best.

@TimonVS
Copy link
Member

TimonVS commented Dec 2, 2019

Hey @ryamaguchi0220, thanks for creating a PR for your issue!
Could you perhaps elaborate on why you want to sort the changelog by title? I am very careful about adding new configuration options since we already have so many, and it's hard to remove once people are using it actively.

@ryamaguchi0220
Copy link
Contributor Author

ryamaguchi0220 commented Dec 3, 2019

@TimonVS Thank you for your response 😉

why you want to sort the changelog by title?

I think this feature has two merits

  • Improve readability of the changelog by grouping the changes by their scope

In my project, each PR include scope that indicates place of the change(e.g, API names) in its title.
Therefore, sorting the changelog by title would makes it easier for users to find changes about scope that they are interested in.

This is readable

✨New features

・[API A] blablabla
・[API A] blablabla
・[API B] blablabla
・[API B] blablabla
・[API C] blablabla

🐛Bug fixes

・[API A] blablabla
・[API A] blablabla
・[API B] blablabla
・[API B] blablabla

This is not readable...

✨New features

・[API B] blablabla
・[API A] blablabla
・[API C] blablabla
・[API A] blablabla
・[API B] blablabla

🐛Bug fixes

・[API A] blablabla
・[API B] blablabla
・[API B] blablabla
・[API A] blablabla
  • Improve readability of the changelog by sorting by what users know and are interested in

My project users don't know and are not interested in when PRs were merged.
It means that users can not figure out what the changelog is sorted by and it would worsen its readability.

@TimonVS
Copy link
Member

TimonVS commented Dec 3, 2019

Those are both excellent points. I'm convinced that this configuration option is desirable, so I'll be merging it and create a new release.

@TimonVS
Copy link
Member

TimonVS commented Dec 3, 2019

@ryamaguchi0220
Copy link
Contributor Author

Thanks for the release!

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 a pull request may close this issue.

2 participants