Git Integration

Overview

HAI Build provides intelligent Git integration that automates commit message generation while maintaining best practices for version control. The AI analyzes your changes and generates clear, conventional commit messages.

Git Commit Message Generation

HAI Build can automatically generate informative commit messages based on your staged changes.

Features

Conventional Commits

Generates messages following conventional commit format

Context-Aware

Analyzes diffs to understand what changed and why

Multi-Repository

Supports workspaces with multiple git repositories

Customizable

Incorporates your notes and preferences

Generating Commit Messages

Stage Your Changes

First, stage the files you want to commit using Git:

git add src/components/UserProfile.tsx
git add src/services/user.service.ts

Or stage all changes:

git add .

Trigger Generation

Generate a commit message using one of these methods:Method 1: Source Control UI

Open the Source Control panel in VS Code
Click the HAI Build icon in the Source Control toolbar

Method 2: Command Palette

Press Cmd+Shift+P (Mac) or Ctrl+Shift+P (Windows/Linux)
Type Generate Commit Message with HAI
Press Enter

The HAI icon appears in your Source Control panel when HAI Build is installed.

Wait for Generation

HAI Build will:

Analyze your staged changes with git diff
Understand what was modified
Generate a concise, descriptive commit message
Insert the message into the commit input box

A progress indicator shows “Generating commit message…”

Review and Edit

The generated message appears in the commit message box:

Review the generated message for accuracy
Edit if you want to add more context or adjust wording
Commit when satisfied

HAI Build populates the message field but doesn’t automatically commit. You maintain full control.

Commit Changes

Commit using your preferred method:

# VS Code UI: Click the checkmark icon
# Or use git command:
git commit
# Message is already populated

Commit Message Format

HAI Build generates messages following the Conventional Commits specification:

Structure

<type>: <short description>

<detailed description (optional)>

Commit Types

HAI Build automatically determines the appropriate type:

Type	Usage
`feat`	New feature or functionality
`fix`	Bug fix
`docs`	Documentation changes
`style`	Code style/formatting (no logic change)
`refactor`	Code refactoring
`perf`	Performance improvements
`test`	Adding or updating tests
`chore`	Maintenance tasks, dependency updates
`ci`	CI/CD configuration changes
`build`	Build system changes

Example Generated Messages

feat: add user profile editing functionality

Implement profile edit form with validation, image upload, 
and API integration. Includes error handling and loading states.

Advanced Features

Adding Developer Notes

Provide context to influence the generated message:

Start Generation

Click the HAI Build icon or use the command palette.

Enter Notes (Optional)

If you’ve already typed notes in the commit message box:

HAI Build reads your existing notes
Incorporates relevant information
Generates message considering your context

Add notes about why you made changes. HAI uses this to create more meaningful messages.

Example:

Your Note

Fixed the performance issue users reported with large datasets

↓ HAI generates:

perf: optimize data rendering for large datasets

Implement virtualization and pagination to handle datasets 
with 10k+ items. Resolves performance degradation reported by users.

Multi-Repository Workspaces

When your workspace contains multiple Git repositories:

Trigger Generation

Click the HAI Build icon or use the command palette.

Select Repository

If multiple repositories have changes, HAI Build prompts:

Select repository for commit message generation:
○ frontend (3 files changed)
○ backend (5 files changed)
○ Generate for all repositories with changes

Generate Messages

Single Repository: Message generated for selected repo
All Repositories: Messages generated for each repo with changes

Canceling Generation

If you need to stop the generation process:

Click the Stop icon that appears during generation
Or use Command Palette: Generate Commit Message with HAI - Stop

Generation typically completes in a few seconds. Canceling is rarely needed.

Best Practices

Stage Related Changes Together

Group logically related changes in a single commit:Good:

# All changes for user authentication feature
git add src/auth/login.ts
git add src/auth/register.ts
git add src/components/LoginForm.tsx

Avoid:

# Unrelated changes in one commit
git add src/auth/login.ts
git add src/reports/analytics.ts
git add src/utils/formatting.ts

This helps HAI generate focused, accurate commit messages.

Review Generated Messages

Always review the generated message:✅ Check:

Accuracy of the description
Appropriate commit type
Completeness of context

✏️ Edit if:

Important context is missing
Wording can be clearer
Ticket/issue numbers should be referenced

Example edit:

Generated:
feat: add user authentication

Edit to:
feat: add user authentication [PROJ-123]

Implement JWT-based authentication with refresh tokens.
Fixes issue where users were logged out prematurely.

Keep Commits Atomic

Each commit should represent a single logical change:Good commits:

✅ feat: add email validation to signup form
✅ fix: resolve memory leak in WebSocket connection
✅ refactor: extract user service to separate module

Poor commits:

❌ fix: multiple bugs and add features
❌ update: changed some files
❌ WIP: stuff

Atomic commits help HAI generate precise messages.

Provide Context in Notes

For complex changes, add context before generating:

Your Note

Refactored the authentication flow to support OAuth2.
Broke backward compatibility with old token format.
Migrations included.

↓ HAI considers this context:

refactor!: migrate authentication to OAuth2

BREAKING CHANGE: Old authentication tokens no longer supported.
Implement OAuth2 flow with authorization code grant.
Include migration script for existing user sessions.

The ! indicates a breaking change, following conventional commits.

Commit Frequently

Smaller, frequent commits are easier to describe:Instead of:

# End of day: 47 files changed
git add .
git commit -m "various updates"

Try:

# After each logical change
git add src/auth/
git commit  # HAI: "feat: implement user authentication"

git add src/profile/
git commit  # HAI: "feat: add user profile management"

git add tests/
git commit  # HAI: "test: add auth and profile tests"

Smaller diffs → More accurate messages

Integration with HAI Workflow

Commit message generation integrates seamlessly with other HAI features:

After Task Execution

Complete Task

Execute a HAI Task or code generation request.

Review Changes

Review the diffs and accept changes.

Stage Changes

git add .

Generate Commit Message

Use HAI Build to generate a message based on the task changes.

Commit

Commit with the generated message.

With Code Generation

Workflow Example

Request: "Add user profile editing feature"
HAI generates: components, services, tests
You review and accept changes
Stage files: git add src/profile/
Generate commit: HAI creates "feat: add user profile editing"
Commit: git commit
Push: git push

Troubleshooting

No Changes to Commit
Generation Fails
Generic Messages
Wrong Commit Type

Issue: “No changes found in repository”Solutions:

Ensure files are staged with git add
Check git status to see if changes exist
Verify you’re in a git repository

Configuration

Customize commit message generation behavior:

Prompt Customization

The commit message generator uses a configurable prompt that:

Follows conventional commit format
Creates 50-72 character titles
Describes what changed and why
Incorporates developer notes

Future versions will support custom prompt templates. Currently, the format follows industry best practices.

Model Selection

Commit messages use your configured LLM provider and model:

Go to Settings in HAI sidebar
Select your preferred LLM provider
Choose a model (faster models work well for commit messages)

Commit message generation works with smaller, faster models since the task is straightforward. You don’t need to use your most powerful model.

Git Best Practices with HAI

Workflow Recommendations

Feature Branch Workflow

git checkout -b feature/user-profiles
# Make changes with HAI
git add .
# Generate commit message
git commit
git push origin feature/user-profiles

Commit Often, Push Less
- Commit after each logical change
- Push after completing a feature or at end of day
- Each commit has a clear, AI-generated message
Use Branches for Tasks
- Create a branch for each HAI Task
- Make commits with generated messages
- Create PR when task is complete

Message History

HAI-generated messages contribute to better:

Code reviews: Clear commit messages help reviewers
Git history: Easy to understand project evolution
Debugging: git log and git blame are more useful
Changelogs: Auto-generate from conventional commits

Next Steps

Task Execution

Execute tasks and commit changes efficiently

Code Generation

Generate code changes worth committing

CLI Usage

Use HAI Build from the command line

Configuration

Customize HAI Build settings

Pro Tip: Combine HAI Build’s code generation with automated commit messages for a seamless development workflow from ideation to version control.

Get Started

Core Features

Configuration

Usage Guides

Advanced

Overview

Git Commit Message Generation

Features

Conventional Commits

Context-Aware

Multi-Repository

Customizable

Generating Commit Messages

Commit Message Format

Structure

Commit Types

Example Generated Messages

Advanced Features

Adding Developer Notes

Multi-Repository Workspaces

Canceling Generation

Best Practices

Integration with HAI Workflow

After Task Execution

With Code Generation

Troubleshooting

Configuration

Prompt Customization

Model Selection

Git Best Practices with HAI

Workflow Recommendations

Message History

Next Steps

Task Execution

Code Generation

CLI Usage

Configuration

Build docs developers (and LLMs) love

Get Started

Core Features

Configuration

Usage Guides

Advanced

​Overview

​Git Commit Message Generation

​Features

Conventional Commits

Context-Aware

Multi-Repository

Customizable

​Generating Commit Messages

​Commit Message Format

​Structure

​Commit Types

​Example Generated Messages

​Advanced Features

​Adding Developer Notes

​Multi-Repository Workspaces

​Canceling Generation

​Best Practices

​Integration with HAI Workflow

​After Task Execution

​With Code Generation

​Troubleshooting

​Configuration

​Prompt Customization

​Model Selection

​Git Best Practices with HAI

​Workflow Recommendations

​Message History

​Next Steps

Task Execution

Code Generation

CLI Usage

Configuration

Build docs developers (and LLMs) love

Overview

Git Commit Message Generation

Features

Generating Commit Messages

Commit Message Format

Structure

Commit Types

Example Generated Messages

Advanced Features

Adding Developer Notes

Multi-Repository Workspaces

Canceling Generation

Best Practices

Integration with HAI Workflow

After Task Execution

With Code Generation

Troubleshooting

Configuration

Prompt Customization

Model Selection

Git Best Practices with HAI

Workflow Recommendations

Message History

Next Steps