Git Commit Messages

Git Commit Messages

Format

type(scope): subject

[optional body]

[optional footer(s)]
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Types

Scopes

Scopes map to app modules. Use the most specific scope that applies:

Rules

• Scope is optional but strongly encouraged.
• Use lowercase, no spaces.
• If a change spans multiple modules, use the primary module or omit the scope.
• CI-only changes can use ci as both type and scope: ci: add coverage gate.

Subject Rules

1. Imperative mood: "add feature" not "added feature" or "adding feature"
2. Lowercase first letter: "add" not "Add"
3. No period at end: "add feature" not "add feature."
4. Max 72 characters: Keep it concise
5. Describe what changed, not what you did

Good vs. Bad

Body Guidelines

• Explain why the change was made (the diff shows what).
• Wrap at 72 characters per line.
• Separate from subject with a blank line.
• Use bullet points for multiple reasons.

feat(expenses): add itemized bill splitting

Implement per-item assignment to users with automatic
sum validation. Uses Largest Remainder Method for fair
distribution of remainders.

- Items can be assigned to one or more users
- Unassigned items are split equally among all members
- Total of item amounts must equal expense total

Footer

Breaking Changes

feat(auth): switch from email to phone-only authentication

BREAKING CHANGE: Email login is no longer supported.
Users must re-authenticate with phone number.

Issue References

Closes #123
Fixes #456
Refs #789

Co-authored-by

Always include when Copilot assists:

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Complete Examples

Feature

feat(expenses): add itemized bill splitting

Implement per-item assignment to users with automatic
sum validation. Uses Largest Remainder Method for fair
distribution of remainders.

Closes #42
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Bug Fix

fix(balances): correct canonical pair ordering for friend balance

The friend pair ID was not consistently using lexicographic
ordering, causing duplicate balance documents. Now always
uses min(userA, userB)_max(userA, userB).

Fixes #78
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Refactor

refactor(core): extract AmountFormatter from expense widgets

Move Indian number formatting (lakhs/crores) into a
dedicated utility class. Eliminates duplicate formatting
logic across 7 widget files.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Performance

perf(groups): lazy-load member avatars in group list

Replace eager loading of all member avatars with
on-demand loading using CachedNetworkImage. Reduces
initial group list load time by ~40% for groups with
10+ members.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

CI

ci: add Firestore rules test to PR pipeline

Run security rules unit tests on every PR targeting
main. Fails the build if any rule test fails.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Breaking Change

feat(sync): migrate offline queue from Hive to Drift

Replace Hive-based sync queue with Drift (SQLite) for
better query support and transaction safety.

BREAKING CHANGE: Existing offline queue entries in Hive
will be lost on upgrade. Users should sync all pending
changes before updating.

Closes #112
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Squash Merge Convention

When a PR is merged via squash merge, the PR title becomes the commit message on the target branch. Therefore:

• PR titles MUST follow conventional commit format: type(scope): subject
• Individual commits on the feature branch are squashed away
• Write good PR titles — they become the permanent history

Example:

• Feature branch has 5 commits: "wip", "add entity", "fix test", "cleanup", "final"
• PR title: feat(expenses): add Expense domain layer with split algorithms
• After squash merge, target branch gets ONE commit: feat(expenses): add Expense domain layer with split algorithms

Quick Reference

feat(scope): add new capability
fix(scope): correct broken behavior
refactor(scope): restructure without behavior change
test(scope): add or update tests
docs(scope): update documentation
perf(scope): improve performance
ci: update CI/CD pipeline
build(scope): change build configuration
chore: maintenance task
style: formatting only

Converted and distributed by TomeVault — claim your Tome and manage your conversions.