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

style: Update changelog section names for clarity #80

Merged
merged 1 commit into from
Feb 12, 2024

Conversation

mdsanima
Copy link
Contributor

@mdsanima mdsanima commented Feb 12, 2024

Updated types name for generating CHANGELOG.md from commit messages using standard-version command.

Standardized section headings in the changelog configuration to improve readability and consistency. Enhanced sections now more accurately reflect content types, such as grouping feature-related changes under "Enhancements" and simplifying the Continuous Integration section to "CI". Removed redundancy and ensured that the emoticons matched the intent of the sections.

This revamp facilitates quicker navigation and understanding of the projects history in the changelog.

Types of section names

This is how the current type section names appear in the changelog file:

Type Section
feat 🤿 Enhancements
perf 🚀 Performance
fix 🚧 Fixes
refactor 💻 Refactors
docs 📝 Documentation
revert ♻️ Revert
build 📦 Build
style 🧢 Style
chore 🎪 Chore
test 🎮 Tests
ci 🤖 CI

Additional items that should be added if necessary during a new release but were not mentioned in the file include:

  • ⚠️ BREAKING CHANGES
  • ❤️ Contributors

Updated types name for generating `CHANGELOG.md` from commit messages
using `standard-version` command.

Standardized section headings in the changelog configuration to improve
readability and consistency. Enhanced sections now more accurately reflect
content types, such as grouping feature-related changes under "Enhancements"
and simplifying the Continuous Integration section to "CI". Removed redundancy
and ensured that the emoticons matched the intent of the sections.

This revamp facilitates quicker navigation and understanding of the
projects history in the changelog.
@mdsanima mdsanima merged commit 0c2fe35 into main Feb 12, 2024
1 check passed
@mdsanima mdsanima deleted the style/update-types branch February 12, 2024 20:38
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 this pull request may close these issues.

1 participant