✨ feat: enhance commit message skill with issue reference suggestions (related to #2)
Some checks failed
Go CI/CD Pipeline / Build and Test (push) Successful in 4m26s
Docker Build and Publish / Version Bump (push) Successful in 10m6s
Go CI/CD Pipeline / Lint and Format (push) Successful in 10m33s
Go CI/CD Pipeline / Version Management (push) Successful in 25s
Main Branch CI/CD (Optimized) / Build and Test (push) Failing after 4m2s
Main Branch CI/CD (Optimized) / Lint and Format (push) Successful in 4m41s
Main Branch CI/CD (Optimized) / Version Management and Docker Build (push) Has been skipped
Docker Build and Publish / Build and Push Docker Image (push) Failing after 5m1s
Some checks failed
Go CI/CD Pipeline / Build and Test (push) Successful in 4m26s
Docker Build and Publish / Version Bump (push) Successful in 10m6s
Go CI/CD Pipeline / Lint and Format (push) Successful in 10m33s
Go CI/CD Pipeline / Version Management (push) Successful in 25s
Main Branch CI/CD (Optimized) / Build and Test (push) Failing after 4m2s
Main Branch CI/CD (Optimized) / Lint and Format (push) Successful in 4m41s
Main Branch CI/CD (Optimized) / Version Management and Docker Build (push) Has been skipped
Docker Build and Publish / Build and Push Docker Image (push) Failing after 5m1s
This commit is contained in:
@@ -50,6 +50,21 @@ git commit -m "✨ feat: add user authentication"
|
||||
git commit -m "✨ feat: implement BDD testing framework"
|
||||
```
|
||||
|
||||
### Issue References
|
||||
```bash
|
||||
# When closing an issue
|
||||
git commit -m "✨ feat: implement workflow optimization (closes #2)"
|
||||
|
||||
# When fixing a bug
|
||||
git commit -m "🐛 fix: resolve CI job failure (fixes #5)"
|
||||
|
||||
# When work is related to an issue
|
||||
git commit -m "📝 docs: update workflow documentation (related to #2)"
|
||||
|
||||
# When referencing for context
|
||||
git commit -m "♻️ refactor: clean up CI code (see #3)"
|
||||
```
|
||||
|
||||
### Bug Fix
|
||||
```bash
|
||||
git commit -m "🐛 fix: resolve port conflict in test server"
|
||||
@@ -80,17 +95,68 @@ git commit -m "🔧 chore: add log output file configuration"
|
||||
git commit -m "🔧 chore: update build system scripts"
|
||||
```
|
||||
|
||||
## Issue Reference Integration
|
||||
|
||||
The skill now integrates with Gitea client to suggest issue references:
|
||||
|
||||
### Automatic Issue Suggestions (NON-BLOCKING)
|
||||
|
||||
When you run `git commit`, the pre-commit hook will:
|
||||
1. **Check for open issues in Gitea** (if available)
|
||||
2. **Display issue suggestions** (helpful information only)
|
||||
3. **Suggest reference formats** (optional guidance)
|
||||
|
||||
**Important:** This is **completely non-blocking** - you can always commit with any message!
|
||||
|
||||
The suggestions are just helpful reminders, never requirements.
|
||||
|
||||
**Example Output:**
|
||||
```
|
||||
🔍 Checking for relevant issues...
|
||||
📋 Found 1 open issue(s):
|
||||
#2: Optimize Gitea Workflow for Main Branch
|
||||
https://gitea.arcodange.lab/arcodange/DanceLessonsCoach/issues/2
|
||||
|
||||
💡 Suggested commit message formats:
|
||||
- closes #<number> (when issue is fully resolved)
|
||||
- fixes #<number> (when fixing a bug)
|
||||
- resolves #<number> (when resolving an issue)
|
||||
- related to #<number> (when work is related)
|
||||
- see #<number> (when referencing for context)
|
||||
|
||||
Example: ✨ feat: implement workflow (closes #2)
|
||||
```
|
||||
|
||||
### Issue Reference Formats
|
||||
|
||||
**Standard Formats:**
|
||||
- `closes #2` - When issue is fully resolved
|
||||
- `fixes #5` - When fixing a specific bug
|
||||
- `resolves #3` - When resolving an issue
|
||||
- `related to #2` - When work is related
|
||||
- `see #4` - When referencing for context
|
||||
|
||||
**GitHub/Gitea Compatible:**
|
||||
These formats are recognized by both GitHub and Gitea to automatically close issues.
|
||||
|
||||
## Git Hooks for Code Quality
|
||||
|
||||
The project includes Git hooks that automatically run before commits to ensure code quality:
|
||||
|
||||
### Pre-commit Hook
|
||||
### Pre-commit Hook (NON-BLOCKING)
|
||||
- **Location**: `.git/hooks/pre-commit`
|
||||
- **Automatically runs**:
|
||||
- **Issue reference suggestions** (helpful but optional)
|
||||
- `go mod tidy` - Cleans up and organizes Go dependencies
|
||||
- `go fmt` - Formats staged Go files according to standards
|
||||
- Auto-adds modified files to the commit
|
||||
|
||||
**Behavior:**
|
||||
- ✅ **Always allows commits** - never blocks you
|
||||
- ✅ **Shows helpful suggestions** - you can ignore them
|
||||
- ✅ **Formats Go code automatically** - but only if you're in a Go project
|
||||
- ✅ **Gracefully handles errors** - continues even if something fails
|
||||
|
||||
### How It Works
|
||||
|
||||
```bash
|
||||
|
||||
Reference in New Issue
Block a user