Skip to content

Follow Conventional Commits for Commit Messages #289

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

Closed
danehans opened this issue Feb 5, 2025 · 4 comments
Closed

Follow Conventional Commits for Commit Messages #289

danehans opened this issue Feb 5, 2025 · 4 comments
Labels
kind/documentation Categorizes issue or PR as related to documentation.

Comments

@danehans
Copy link
Contributor

danehans commented Feb 5, 2025

Conventional Commits specifies adding human and machine-readable meaning to commit messages. Establishing Conventional Commits as a standard for commit messages will help automating releases.

Commit message with description and breaking change footer

feat: allow provided config object to extend other configs
BREAKING CHANGE: `extends` key in config file is now used for extending other config files

Commit message with ! to draw attention to breaking change

feat!: send an email to the customer when a product is shipped

Note: The project already follows the fix: convention.

@danehans danehans mentioned this issue Feb 5, 2025
4 tasks
@danehans
Copy link
Contributor Author

danehans commented Feb 5, 2025

xref to improve changelog automation: #290
xref example PR: #291

@danehans danehans changed the title Follow Conventional Commits for Commits Follow Conventional Commits for Commit Messages Feb 5, 2025
@danehans danehans added the kind/documentation Categorizes issue or PR as related to documentation. label Feb 5, 2025
@kfswain
Copy link
Collaborator

kfswain commented Feb 5, 2025

Can we convert this one into a discussion for now?

@danehans
Copy link
Contributor Author

danehans commented Feb 6, 2025

Will do.

@danehans
Copy link
Contributor Author

danehans commented Feb 6, 2025

Converted to #293 discussion.

@danehans danehans closed this as completed Feb 6, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/documentation Categorizes issue or PR as related to documentation.
Projects
None yet
Development

No branches or pull requests

2 participants