Files

Gabriel Radureau c1e628f339 📝 docs: update comprehensive documentation and project infrastructure

Documentation Updates:
- Enhanced AGENTS.md with user authentication details
- Updated README.md with authentication API documentation
- Added CONTRIBUTING.md guidelines for BDD testing
- Version management guide improvements
- Local CI/CD testing documentation

Project Infrastructure:
- Updated .gitignore for new file patterns
- Enhanced git hooks documentation
- YAML linting configuration
- Script improvements and organization
- Configuration management updates

API Enhancements:
- Greet service integration with authentication
- Server middleware for JWT validation
- Telemetry improvements
- Version management utilities

Generated by Mistral Vibe.
Co-Authored-By: Mistral Vibe <vibe@mistral.ai>

2026-04-09 00:26:15 +02:00

1.6 KiB

Raw Blame History

Git Hooks for dance-lessons-coach

This directory contains Git hooks for the dance-lessons-coach project.

Available Hooks

pre-commit

Location: .git/hooks/pre-commit
Purpose: Automatically runs go mod tidy and go fmt before commits
Features:
- Runs go mod tidy to clean up dependencies
- Automatically adds modified go.mod and go.sum to commit
- Runs go fmt on all Go files (excluding vendor and .git directories)
- Automatically adds formatted files to commit
- Only runs if in a Go project (checks for go.mod)

Installation

The pre-commit hook is already installed and executable. No additional setup required.

Usage

The hooks run automatically when you commit:

git add .
git commit -m "Your commit message"

The hook will:

Run go mod tidy
Run go fmt on all Go files
Add any modified files to your commit
Allow the commit to proceed if successful

Customization

To modify the hooks:

Edit the hook file in .git/hooks/
Make it executable: chmod +x .git/hooks/hook-name

Disabling Hooks

To temporarily disable hooks:

# Skip pre-commit hook for one commit
git commit --no-verify -m "Your commit message"

Best Practices

Let the hooks run automatically - they ensure code quality
The hooks only modify files that need changes
All changes are added to your commit automatically
Hooks run quickly and prevent common issues

Troubleshooting

If a hook fails:

Check the error message
Fix the issue manually
Commit again

Common issues:

go mod tidy fails: Check your Go module dependencies
go fmt fails: Check for syntax errors in your Go code

1.6 KiB Raw Blame History