@@ -93,6 +93,7 @@ smart-git-commit --help
9393usage: smart-git-commit [-h] [--repo-path REPO_PATH] [--non-interactive]
9494 [--ollama-host OLLAMA_HOST]
9595 [--ollama-model OLLAMA_MODEL] [--no-ai]
96+ [--timeout TIMEOUT]
9697
9798Smart Git Commit Workflow with Ollama Integration
9899
@@ -106,6 +107,7 @@ options:
106107 --ollama-model OLLAMA_MODEL
107108 Model to use for Ollama (will prompt if not specified)
108109 --no-ai Disable AI-powered analysis
110+ --timeout TIMEOUT Timeout in seconds for HTTP requests (default: 10)
109111```
110112
111113## Example Commit
@@ -237,6 +239,14 @@ smart-git-commit --repo-path /path/to/your/repository
237239- Try a smaller model like gemma:2b or tinyllama
238240- Check Ollama server logs for any errors or memory issues
239241
242+ #### Connection Timeouts
243+ - If you experience connection timeouts with Ollama, you can adjust the timeout parameter:
244+ ``` bash
245+ # Increase the timeout to 30 seconds
246+ smart-git-commit --timeout 30
247+ ```
248+ - For slow networks or large models, a longer timeout may be necessary
249+
240250### Ollama Connection Issues
241251
242252If you encounter issues connecting to Ollama:
@@ -263,6 +273,23 @@ smart-git-commit --no-ai
263273 - An Ollama-compatible system
264274 - Internet connection (for initial model download)
265275
276+ ## To-Do / Future Features
277+
278+ Here are some planned enhancements and features for future releases:
279+
280+ - ** GitHub/GitLab Integration** : Automatic issue linking and PR description generation
281+ - ** Commit Squashing** : Intelligently squash related commits for cleaner history
282+ - ** Multiple AI Backends** : Support for additional AI providers beyond Ollama (like OpenAI, Anthropic, or local models)
283+ - ** Interactive TUI Mode** : Text-based user interface for easier navigation through changes
284+ - ** Custom Commit Templates** : Support for user-defined commit templates and conventions
285+ - ** Config File Support** : Persistent user configurations and project-specific settings
286+ - ** Pre-commit Hook Integration** : Run as a Git hook for seamless workflow integration
287+ - ** Bulk Processing Mode** : Process multiple repositories in batch mode for organization-wide standards
288+ - ** Plugin System** : Allow extensions to add custom functionality
289+ - ** Performance Optimization** : Faster processing of large repositories with many changes
290+
291+ Contributions to any of these features are welcome! See the Contributing section below.
292+
266293## Contributing
267294
268295Contributions are welcome! Please feel free to submit a Pull Request.
@@ -271,7 +298,22 @@ To set up your development environment:
271298
2722991 . Clone the repository
2733002 . Install development dependencies: ` pip install -e ".[dev]" `
274- 3 . Run tests: ` pytest tests/ `
301+ 3 . Run tests: ` pytest tests/ ` or use the included test runner: ` python run_tests.py `
302+
303+ ### Running Tests
304+
305+ The project includes a test runner script with coverage reporting:
306+
307+ ``` bash
308+ # Run tests with verbose output
309+ python run_tests.py -v
310+
311+ # Run tests with coverage reporting (requires the coverage package)
312+ python run_tests.py -c
313+
314+ # Run tests with both verbose output and coverage reporting
315+ python run_tests.py -v -c
316+ ```
275317
276318## License
277319
284326
285327# Changelog
286328
329+ ## 0.1.5 (2025-04-26)
330+ - Fixed issue with file paths when running from subdirectories
331+ - Fixed commit message file path handling in git repositories
332+ - Added timeout parameter for better control of network operations
333+ - Improved error handling for network and connection issues
334+ - Enhanced Test Coverage with clear instructions of usage
335+
287336## 0.1.4 (2025-04-25)
288337- UnicodeDecodeError fixed
289338
0 commit comments