Files
ISA-Frontend/.github/commit-instructions.md
Lorenz Hilpert 093bb3b484 Update commit message structure in guidelines
- 📚 **Docs**: Revised commit message instructions for clarity
2025-04-01 17:29:38 +02:00

1.1 KiB

Commit Message Instructions

Format

Each commit message should follow this structure:

  1. Short Summary: A brief summary of the changes (max 72 characters).
  2. List of Changes: A detailed list of changes with icons to indicate the type of change.

Example

Added a new module to handle user authentication, including login and registration.

- ✨ **Feature**: Implemented user login functionality
- 🐛 **Fix**: Resolved session timeout issue
- 🛠️ **Refactor**: Improved error handling in auth service
- 🧪 **Test**: Added unit tests for login component

Icons for Change Types

  • Feature: New features or functionality
  • 🐛 Fix: Bug fixes
  • 🛠️ Refactor: Code improvements without changing functionality
  • 🧪 Test: Adding or updating tests
  • 📚 Docs: Documentation updates
  • 🗑️ Chore: Maintenance tasks (e.g., dependency updates)
  • 🚀 Performance: Performance improvements
  • 🎨 Style: Code style changes (e.g., formatting)
  • 🔒 Security: Security-related changes
  • ⚙️ Config: Configuration changes