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

Use conventional commits #23

Closed
Chalarangelo opened this issue Feb 4, 2022 · 0 comments
Closed

Use conventional commits #23

Chalarangelo opened this issue Feb 4, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Milestone

Comments

@Chalarangelo
Copy link
Owner

Chalarangelo commented Feb 4, 2022

From v2 onwards, we will be using conventional commits. This will help with generating changelogs etc. Additionally, all work will be done on the v2 trunk using feature branches and they will be rebase-merged in all cases, effectively removing any and all merge commits from the trunk. We shall adhere to this convention for all future changes, too.

Commit types

Commit Type Title Description Emoji
feat Features A new feature
fix Bug Fixes A bug Fix 🐛
docs Documentation Documentation only changes 📚
style Styles Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc) 💎
refactor Code Refactoring A code change that neither fixes a bug nor adds a feature 📦
perf Performance Improvements A code change that improves performance 🚀
test Tests Adding missing tests or correcting existing tests 🚨
build Builds Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm) 🛠
ci Continuous Integrations Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs) ⚙️
chore Chores Other changes that don't modify src or test files ♻️
revert Reverts Reverts a previous commit 🗑

Source

@Chalarangelo Chalarangelo added documentation Improvements or additions to documentation enhancement New feature or request labels Feb 4, 2022
@Chalarangelo Chalarangelo added this to the 2.0 milestone Feb 4, 2022
@Chalarangelo Chalarangelo pinned this issue Aug 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant