Welcome to the Commit Coach documentation! This directory contains comprehensive guides for using and configuring Commit Coach.
-
Rules Documentation - Complete guide to creating and configuring rules
- Available variables and conditions
- Built-in rules reference
- Custom rule examples
- Best practices
-
Examples - Practical configuration examples
- Project-specific configurations (Node.js, React, Python, Go)
- Team workflow examples
- Advanced configurations
- Troubleshooting guides
- Main README - Getting started and basic usage
- Configuration Example - Sample configuration file
- Usage Examples - Command-line usage examples
- Contributing Guide - How to contribute to Commit Coach
- New to Commit Coach? Start with the main README
- Want to customize rules? Check out the Rules Documentation
- Looking for examples? Browse the Examples for your project type
- Need help? Open an issue
docs/
├── README.md # This file - documentation index
├── RULES.md # Complete rules reference and guide
└── EXAMPLES.md # Practical configuration examples
Found an error or want to improve the documentation? We welcome contributions!
- Fork the repository
- Make your changes
- Submit a pull request
See the Contributing Guide for more details.
When contributing to documentation:
- Use clear, concise language
- Include practical examples
- Keep examples up-to-date with the latest features
- Test all code examples before submitting
- Follow the existing documentation style