Commit Message Workflow¶

For the full command reference, see devo commit.

Learn how to generate conventional commit messages using AI.

Quick Start¶

# Stage your changes
git add .

# Generate commit message
devo commit

Edit your files as usual:

vim src/auth.py
vim tests/test_auth.py

# Stage specific files
git add src/auth.py tests/test_auth.py

# Or stage all changes
git add .

devo commit

The AI analyzes your staged changes and generates a commit message. See devo commit for the full format specification and list of commit types.

The tool shows the generated message. You can:

Use this format for automatic ticket extraction:

<type>/<TICKET-NUMBER>-description

Examples:

The tool extracts the ticket number from your branch name and includes it in the commit message:

# Branch: feature/XYZ-123-add-auth
# Generated message:
feat(auth): XYZ-123 add JWT token validation

git checkout -b feature/XYZ-123-add-authentication

vim src/auth.py
vim tests/test_auth.py

git add .
devo code-reviewer

# Fix any issues found
vim src/auth.py

# Stage changes
git add .

devo commit

git push origin feature/XYZ-123-add-authentication

Stage related changes together: Group related files for coherent messages
Use descriptive branch names: Include ticket numbers for automatic extraction
Review before committing: Run devo code-reviewer first
Keep changes focused: Smaller commits get better messages
Edit if needed: The generated message is a starting point

For better messages:

For errors related to missing staged changes or AWS credentials, see the devo commit reference.