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.

Sign up for GitHub

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

Jump to bottom

GitHub releases list sections alphabetically, should put Features first instead #3038

Closed
lilyball opened this issue Sep 6, 2021 · 1 comment · Fixed by #3045
Closed

GitHub releases list sections alphabetically, should put Features first instead #3038

lilyball opened this issue Sep 6, 2021 · 1 comment · Fixed by #3045
Labels
📚 documentation Issues for improving the documentations 🌱 good first issue Good first issue to get your feet wet.

Comments

@lilyball
Copy link

lilyball commented Sep 6, 2021

Bug Report

Current Behavior

When viewing GitHub releases, all the sections are alphabetized. For example, v0.57.0 lists Bug Fixes, Build, Chore, Code Refactoring, Continuous Integration, Docs, Features, Style. Other releases follow this same rule.

Expected Behavior

The release note sections should be organized in order of most interesting to end users. This should generally put Features first, then probably Bug Fixes. After that, probably Style, Performance Improvements, and Docs. And then all of the developer-facing stuff.
@lilyball lilyball added the 🐛 bug Something isn't working as expected. label Sep 6, 2021
@andytom andytom added the 🌱 good first issue Good first issue to get your feet wet. label Sep 6, 2021
@andytom
Copy link
Member

andytom commented Sep 6, 2021 •
edited
Loading

We use git chglog to generate the change log so this should just be a case of updating the config file.

@andytom andytom added 📚 documentation Issues for improving the documentations and removed 🐛 bug Something isn't working as expected. labels Sep 6, 2021
CuriousCorrelation added a commit to CuriousCorrelation/starship that referenced this issue Sep 8, 2021
@CuriousCorrelation
docs(chglog): Change release page title order (starship#3038)
314a6e9 
Changed release page commit group title order from
alphabetical to feat, fix, docs, style, refactor, pref, test, build, ci,
chore, revert.
Matches Semantic PR conventional commit types.
@CuriousCorrelation CuriousCorrelation mentioned this issue Sep 8, 2021
Merged
matchai pushed a commit that referenced this issue Sep 8, 2021
@CuriousCorrelation
docs(chglog): Change release page title order (#3038) (#3045)
cb8dca2 
Changed release page commit group title order from
alphabetical to feat, fix, docs, style, refactor, pref, test, build, ci,
chore, revert.
Matches Semantic PR conventional commit types.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
📚 documentation Issues for improving the documentations 🌱 good first issue Good first issue to get your feet wet.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs(chglog): Change release page title order (#3038) CuriousCorrelation/starship
2 participants
@lilyball @andytom
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy