Semantic Commit Guidance

This guide provides definitions and examples of semantic commits that you can use in your project. Each commit type should use a semantic label and description structure. This will facilitate collaboration among team members and improve the maintainability and comprehensibility of the project.

Commit Types and Descriptions

1. feat 🆕 – New Feature

   git commit -m "feat ✨ : Added user profile page"

2. fix 💥 – Bug Fix

   git commit -m "fix 💥: Resolved issue with user login"

3. chore ✴️ – Miscellaneous Changes

   git commit -m "chore ✴️ : Updated dependencies"

4. refactor ✏️ – Code Refactoring

   git commit -m "refactor✏️ : Optimized database queries"

5. docs 📄 – Documentation Updates

   git commit -m "docs 📄 : Updated project README file"

6. style 🎨 – Code Formatting and Style Changes

   git commit -m "style 🎨 : Applied whitespace adjustments"

7. test ✅ – Test Updates

   git commit -m "test ✅ : Added user login test cases"

8. perf 🍀 – Performance Improvements

   git commit -m "perf 🍀 : Accelerated database access"

9. ci ➰ – Continuous Integration Related Changes

   git commit -m "ci ➰ : Updated CI workflow"

10. build ⚡ – Build System or External Dependency Changes

    git commit -m "build ⚡ : Updated Webpack configuration"

11. revert 🔙 – Revert a Previous Commit

    git commit -m "revert 🔙 : Reverted commit with hash 34a2b78"

12. add ✨ – Adding New File, Function, Method, Variable, etc.

    git commit -m "add 🆕 : Added user login function"

13. remove 🔥 – Removing File, Function, Method, Variable, etc.

    git commit -m "remove 🔥 : Removed deprecated user login function"

14. update 🆕 – Updating File, Function, Method, Variable, etc.

    git commit -m "update🆕 : Updated home page design"

15. rename 🔁 – Renaming File, Function, Method, Variable, etc.

    git commit -m "rename 🔁 : Renamed `util` library to `helpers`"

16. move 📦 – Moving File, Function, Method, Variable, etc.

    git commit -m "move 📦 : Moved helper functions to the `helpers` folder"

17. copy ©️ – Copying File, Function, Method, Variable, etc.

    git commit -m "copy ©️ : Copied reusable form functions"

18. security 🔒 – Security Related Changes

    git commit -m "security 🔒 : Fixed SQL injection vulnerability"

19. version 🔏 – Version Change

    git commit -m "version 🔏 : Upgraded project to version 1.2.0"

---

For an effective software team, commit messages should be descriptive and consistent. You can use the examples in this guide to document your project's changes with meaningful and well-labeled commits. By following this guide for your commits, you can improve the project's maintainability and enhance collaboration.

(Note: While using the example commits in real projects, it is essential to add more detailed commit descriptions suitable for your actual changes and use English and .md format for documentation.)