Skip to content

Commit 3c2f455

Browse files
committed
docs(docs): Add project logo and support section
Adds a project logo and introduces a basic support section to the README. This enhances the project's visual appeal and provides a starting point for future documentation. The logo helps with project recognition and branding. The support section prepares for community contribution guidelines. Affected files: - M README.md
1 parent 01e1ee3 commit 3c2f455

File tree

1 file changed

+80
-13
lines changed

1 file changed

+80
-13
lines changed

README.md

Lines changed: 80 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,21 @@
1+
2+
<p align="center">
3+
<img src="smart-commit.png" alt="Smart Git Commit" width="256" height="256"/>
4+
</p>
5+
16
# Smart Git Commit 🚀
27

38
An AI-powered Git workflow tool that intelligently analyzes your changes, groups them into logical commits, and generates detailed conventional commit messages.
49

10+
## ❤️ Support This Project
11+
12+
If you find Smart Git Commit helpful for your workflow, please consider supporting the development:
13+
14+
- **[GitHub Sponsors](https://github.com/sponsors/CripterHack)**: Become a sponsor through GitHub
15+
- **[PayPal](http://paypal.com/paypalme/cripterhack)**: Make a one-time donation
16+
17+
Your support helps maintain this project and develop new features!
18+
519
## Features
620

721
- 🤖 **AI-Powered Analysis**: Leverages Ollama models to understand your code changes
@@ -13,6 +27,10 @@ An AI-powered Git workflow tool that intelligently analyzes your changes, groups
1327
- 🎯 **Smart Change Importance**: Prioritizes changes based on impact analysis
1428
- 🧩 **Component Detection**: Identifies file components based on project structure
1529

30+
## Installation from PyPI
31+
32+
The package is available on PyPI and can be installed using pip: https://pypi.org/project/smart-git-commit/
33+
1634
## Prerequisites
1735

1836
### Basic Requirements
@@ -94,7 +112,7 @@ usage: smart-git-commit [-h] [--repo-path REPO_PATH] [--non-interactive]
94112
[--ollama-host OLLAMA_HOST]
95113
[--ollama-model OLLAMA_MODEL] [--no-ai]
96114
[--timeout TIMEOUT] [--verbose] [--skip-hooks]
97-
[--no-revert]
115+
[--no-revert] [--version]
98116
99117
Smart Git Commit Workflow with Ollama Integration
100118
@@ -112,6 +130,7 @@ options:
112130
--verbose Show verbose debug output
113131
--skip-hooks Skip Git hooks when committing (useful if pre-commit is not installed)
114132
--no-revert Don't automatically revert staged changes on error
133+
--version Show version information and support links
115134
```
116135

117136
## Example Commit
@@ -323,16 +342,16 @@ smart-git-commit --no-ai
323342

324343
Here are some planned enhancements and features for future releases:
325344

326-
- **GitHub/GitLab Integration**: Automatic issue linking and PR description generation
327-
- **Commit Squashing**: Intelligently squash related commits for cleaner history
328-
- **Multiple AI Backends**: Support for additional AI providers beyond Ollama (like OpenAI, Anthropic, or local models)
329-
- **Interactive TUI Mode**: Text-based user interface for easier navigation through changes
330-
- **Custom Commit Templates**: Support for user-defined commit templates and conventions
331-
- **Config File Support**: Persistent user configurations and project-specific settings
332-
- **Pre-commit Hook Integration**: Run as a Git hook for seamless workflow integration
333-
- **Bulk Processing Mode**: Process multiple repositories in batch mode for organization-wide standards
334-
- **Plugin System**: Allow extensions to add custom functionality
335-
- **Performance Optimization**: Faster processing of large repositories with many changes
345+
- [ ] **GitHub/GitLab Integration**: Automatic issue linking and PR description generation
346+
- [ ] **Commit Squashing**: Intelligently squash related commits for cleaner history
347+
- [ ] **Multiple AI Backends**: Support for additional AI providers beyond Ollama (like OpenAI, Anthropic, or local models)
348+
- [ ] **Interactive TUI Mode**: Text-based user interface for easier navigation through changes
349+
- [ ] **Custom Commit Templates**: Support for user-defined commit templates and conventions
350+
- [ ] **Config File Support**: Persistent user configurations and project-specific settings
351+
- [ ] **Pre-commit Hook Integration**: Run as a Git hook for seamless workflow integration
352+
- [ ] **Bulk Processing Mode**: Process multiple repositories in batch mode for organization-wide standards
353+
- [ ] **Plugin System**: Allow extensions to add custom functionality
354+
- [x] **Performance Optimization**: Faster processing of large repositories with many changes
336355

337356
Contributions to any of these features are welcome! See the Contributing section below.
338357

@@ -361,6 +380,15 @@ python run_tests.py -c
361380
python run_tests.py -v -c
362381
```
363382

383+
## Sponsorship
384+
385+
If this tool saves you time or helps your workflow, please consider supporting its development:
386+
387+
- **[GitHub Sponsors](https://github.com/sponsors/CripterHack)**: Support ongoing development through GitHub
388+
- **[PayPal](http://paypal.com/paypalme/cripterhack)**: Make a one-time donation
389+
390+
Every contribution helps maintain this project and add new features. Thank you for your support! ❤️
391+
364392
## License
365393

366394
MIT
@@ -372,7 +400,46 @@ MIT
372400

373401
# Changelog
374402

375-
## 0.1.6 (2025-04-27)
403+
## 0.2.0 (2025-04-25)
404+
- Major enhancement to component detection for modern tech stacks and architectures
405+
- Added support for monorepo structures with package-specific commit grouping
406+
- Expanded commit type taxonomy with 8 new conventional commit types
407+
- Improved commit message formatting to follow GitHub best practices
408+
- Enhanced non-AI commit generation with more intelligent grouping
409+
- Added sophisticated tech stack detection for 30+ frameworks and libraries
410+
- Updated formatter detection to recognize more linting tools
411+
- Implemented smarter naming for commits with descriptive prefixes
412+
- Improved frontend and backend framework component detection
413+
- Made default timeout configurable through the codebase with a central constant
414+
- Better resource utilization with improved CPU and memory detection
415+
416+
## 0.1.9 (2025-04-25)
417+
- Increased default timeout from 10 to 30 seconds to avoid frequent timeouts with larger models
418+
- Fixed issue with truncated filenames when staging files for commit
419+
- Improved error handling for file staging operations with better error messages
420+
- Enhanced git configuration validation with user-friendly messaging
421+
- Added parameter descriptions with defaults in help text
422+
423+
## 0.1.8 (2025-04-25)
424+
- Improved CLI interface with enhanced progress indicators and loading spinners
425+
- Added automatic download of recommended model if no models are available
426+
- Enhanced model selection UI with model size indicators and recommendations
427+
- Implemented intelligent warm-up for models with realistic prompts
428+
- Added resource-awareness to adapt batch processing based on system capabilities
429+
- Improved parallel processing with automatic fallback for low-resource systems
430+
- Added detailed statistics about system resources during startup
431+
- Fixed spinner display during user interaction for better UX
432+
- Added more informative feedback during model initialization and processing
433+
- Added donation links and sponsor information throughout the application
434+
- Added --version flag to display version and project information
435+
- Optimized memory usage for large repositories with change batching
436+
437+
## 0.1.7 (2025-04-25)
438+
- Enhanced pre-commit hook detection with automatic retry on failure
439+
- Added automatic hook skipping in non-interactive mode for repositories with pre-commit issues
440+
- Added proper success/failure tracking across multiple commit attempts
441+
442+
## 0.1.6 (2025-04-25)
376443
- Improved error handling for git repositories and file paths
377444
- Added detection and proper handling when running from subdirectories
378445
- Added clear, user-friendly error messages with actionable instructions
@@ -385,7 +452,7 @@ MIT
385452
- Expanded troubleshooting documentation with common error solutions
386453
- Added relative path resolution to prevent path duplication issues
387454

388-
## 0.1.5 (2025-04-26)
455+
## 0.1.5 (2025-04-25)
389456
- Fixed issue with file paths when running from subdirectories
390457
- Fixed commit message file path handling in git repositories
391458
- Added timeout parameter for better control of network operations

0 commit comments

Comments
 (0)