Skip to content

Commit d0005e6

Browse files
committed
Enhance documentation for Commit Coach with comprehensive guides and examples
- Added README.md for an overview of Commit Coach documentation structure and quick links. - Introduced RULES.md detailing rule configuration, available variables, built-in rules, and best practices. - Created EXAMPLES.md with practical configuration examples for various project types and team workflows. - Updated main README to include links to new documentation resources for better user guidance.
1 parent bea537e commit d0005e6

4 files changed

Lines changed: 1164 additions & 0 deletions

File tree

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,17 @@ integrations:
8282
- **Commit Quality**: Flags large commits and short messages
8383
- **Breaking Changes**: Detects potential breaking changes
8484
85+
📖 **[Complete Rules Documentation](docs/RULES.md)** - Learn how to create custom rules and configure all available options.
86+
87+
📋 **[Configuration Examples](docs/EXAMPLES.md)** - See practical examples for different project types and team workflows.
88+
89+
## Documentation
90+
91+
- 📚 **[Documentation Index](docs/README.md)** - Complete documentation overview
92+
- 📖 **[Rules Reference](docs/RULES.md)** - All available variables, conditions, and examples
93+
- 📋 **[Configuration Examples](docs/EXAMPLES.md)** - Project-specific configurations
94+
- 🚀 **[Usage Examples](examples/USAGE.md)** - Command-line usage and CI/CD integration
95+
8596
## Action Inputs
8697
8798
| Input | Description | Required | Default |

0 commit comments

Comments
 (0)