mirror of
https://dev.azure.com/hugendubel/ISA/_git/ISA-Frontend
synced 2025-12-28 22:42:11 +01:00
3c110efdfa
Introduced new documentation files for state management and testing guidelines to enhance developer understanding and best practices. - 📚 **Docs**: Added state management guidelines with local and global state recommendations - 📚 **Docs**: Created testing guidelines including unit testing requirements and best practices - 📚 **Docs**: Updated project structure documentation for clarity
40 lines
1.2 KiB
Markdown
40 lines
1.2 KiB
Markdown
# Commit Message Instructions
|
|
|
|
## Format
|
|
|
|
Each commit message should follow this structure:
|
|
|
|
1. **Title**: A concise summary of the changes (max 50 characters).
|
|
2. **Short Summary**: A brief summary of the changes (max 72 characters).
|
|
3. **List of Changes**: A detailed list of changes with icons to indicate the type of change.
|
|
|
|
---
|
|
|
|
### Example
|
|
|
|
```
|
|
✨ Add user authentication module
|
|
|
|
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
|