Skip to content

Latest commit

 

History

History
271 lines (219 loc) · 4.58 KB

README_SMALL.md

File metadata and controls

271 lines (219 loc) · 4.58 KB

⚡ Gitlog

🔦 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.


Message format

🪪 A standardized structure used during commits to maintain clarity and consistency in project history. 

<emoji> <type>(<scope>): <subject>

<body>

<footer>

Merge format

🥏 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>

Commit messages:

🌃 Common types of commit messages with their corresponding emojis:


0. Initialization

🎉 init(project): initial commit

1. Features and enhancement

✨ feat(): new feature
⚡ perf(): performance improvements
🎨 design(): ui/ux design improvements
📈 analytics(): analytics or tracking code
🔌 integration(): external integrations

2. Bug fixes

🐛 fix(): bug fix
🔍 debug(): debugging changes
👨‍🔧 patch(): minor fix or patch

3. Documentation

📚 docs(): documentation changes
📝 update(): minor updates
📖 guide(): update or add a guide

4. 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 code

5. 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 monitoring

6.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 changes

8. 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 updates

10. 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 warnings

11. Please

🙏 pls(): request or polite suggestion

Commit message scopes:

💡 Following scopes are commonly used in commit messages to indicate specific areas of the project affected by the changes:


  • auth
  • api
  • ui
  • database
  • components
  • config
  • tests
  • security
  • build
  • server
  • styles
  • checkout
  • payments
  • notifications
  • user
  • css
  • layout
  • frontend
  • backend
  • forms
  • router
  • passed
  • failed

Contributing

⛓️‍💥 Feel free to submit pull requests to add more commit types or scope types to this list.


Footnotes

  1. commit-messages ↩