π¦ A list of common git commit messages for clear and consistent version control. Just copy, paste and customize.
π‘ Inspiration1.
Important
π° Before getting started, please familiarize yourself with the proper commit message format, including the use of emojis for different commit types.
Caution
π Kindly do not use the default Update file message.
πͺͺ A standardized structure used during commits to maintain clarity and consistency in project history.
<emoji> <type>(<scope>): <subject>
<body>
<footer>π₯ A format used during merges to clearly document merge actions in the project history.
<emoji> <type>(<scope>): <subject>
- <points>
- <points>
Contributor: <user>
Co-contributor: <user>
Closes #<issue>π Common types of commit messages with their corresponding emojis:
0. Initialization
π init(project): initial commit1. Features and enhancement
β¨ feat(): new featureβ‘ perf(): performance improvementsπ¨ design(): ui/ux design improvementsπ analytics(): analytics or tracking codeπ integration(): external integrations2. Bug fixes
π fix(): bug fixπ debug(): debugging changesπ¨βπ§ patch(): minor fix or patch3. Documentation
π docs(): documentation changesπ update(): minor updatesπ guide(): update or add a guide4. Code styling and refactoring
π style(): code formattingβ»οΈ refactor(): code refactoringπ§Ή cleanup(): clean-up or refactor of unused codeπ οΈ fix(): code improvementsπ₯ remove(): removing files or code5. Testing and maintenance
βοΈ test(passed): adding/modifying/result testsβ test(failed): adding/modifying/result testsπ§ chore(): maintenance tasksπ¨ build(): changes to the build processπ§ wip(): work in progressπ metrics(): metrics and monitoring6.Non-feature Changes
π non-feature(): non-feature change (json)
7. Security and reverting changes
π security(): security improvementsπ revert(): reverting previous changesπ‘οΈ protect(): security patches or fixesπ api(): api-related changes8. Deployments and builds
π deploy(): deploy-related changesπ¦ build(): changes to build configurationπ§ͺ ci(): continuous Integration changesπ¨ setup(): setup or config changesπ§° deps(): adjust dependencies (upgrade/downgrade)
9. Database and infrastructure
ποΈ db(): database changesπ· infra(): infrastructure improvementsπ‘ network(): network configurations or updates10. Others
π€ release(): new releases or version bumpsπ dumpversion(): dumping version info or changelogπ ref(): reference updates or reorganizationπ¬ discussion(): ongoing discussions or issue resolutionsβοΈ config(): configuration changesπ§ tweak(): minor adjustments or tweaksπ¨ alert(): important notices or warnings11. Please
π pls(): request or polite suggestionπ‘ Following scopes are commonly used in commit messages to indicate specific areas of the project affected by the changes:
authapiuidatabasecomponentsconfigtestssecuritybuildserverstylescheckoutpaymentsnotificationsusercsslayoutfrontendbackendformsrouterpassedfailed
βοΈβπ₯ Feel free to submit pull requests to add more commit types or scope types to this list.