example.py

#!/usr/bin/env python3
"""
Example usage of commit_gen.py
"""

# This example demonstrates how the tool works

# 1. Make some changes to your repository
# 2. Stage them with git add
# 3. Run the tool:
#
#    python commit_gen.py
#
# The tool will analyze your changes and suggest a commit message.

# Example scenarios:

# Scenario 1: Adding a new feature
# $ git add src/auth/login.py
# $ python commit_gen.py
# Output: feat(auth): add login functionality

# Scenario 2: Fixing a bug
# $ git add src/api/users.py
# $ python commit_gen.py
# Output: fix(api): resolve issue in users

# Scenario 3: Updating documentation
# $ git add README.md docs/guide.md
# $ python commit_gen.py
# Output: docs: update documentation

# Scenario 4: Refactoring code
# $ git add src/utils/helpers.py
# $ git rm src/utils/old_helpers.py
# $ python commit_gen.py
# Output: refactor(utils): restructure helpers