name: oad/commit description: OpenAgentd workflow for well-formatted, detailed conventional commits.
Git Commit Execution Workflow
- Stage: Run
git status --porcelain. If no files are staged, executegit add .. - Analyze: Run
git diff --cachedto evaluate the technical scope and architectural impact (e.g., DDD shifts or C4 updates). - Sync Docs: Update related documentation files automatically to align with the changes made in the codebase.
- Generate Message:
- Format:
<type>: <subject> - Subject: Auto-generate a concise imperative subject from the staged changes.
- Body: Leave a blank line, then detail Motivation, Technical Changes (bulleted deep-dive), and Impact.
- Format:
- Commit: Execute
git commit -m "<message>"and output the commit hash and a brief summary.
Note: Multiple commits are preferred for large changes. If the scope is too broad, break it down into smaller, focused commits following the same workflow (do not force to have multiple commits if the change is small and cohesive).
Commit Conventions
| Category | Type |
|---|---|
| Features | feat |
| Fixes | fix |
| Refactor | refactor |
| Maintenance | chore/docs |
| Style | style |