docs(claude): Add dialogue format markers for commit messages

User: 'The current examples don't clearly show it's a dialogue'
Assistant: Added explicit 'User:' and 'Assistant:' markers to make
conversation flow more obvious in commit bodies.

User: 'Make it clear this is about dialogue'
Assistant: Updated examples to show actual conversation exchanges
with arrows (→) for quick actions and clear dialogue structure.

This makes commit messages more readable and the user-AI collaboration
context immediately apparent to future developers.

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
Kazuki Yamada
2025-06-08 18:08:06 +09:00
parent 23b7f2c109
commit 60ecce1ce7

View File

@@ -121,13 +121,15 @@ npm run test
- Follow [Conventional Commits](https://www.conventionalcommits.org/) with scope: `type(scope): Description` - Follow [Conventional Commits](https://www.conventionalcommits.org/) with scope: `type(scope): Description`
- Write detailed commit messages focusing on the "why" rather than the "what" - Write detailed commit messages focusing on the "why" rather than the "what"
- **Include user dialogue context**: Reference the specific conversation or request that led to the change in the commit body - **Include user dialogue context**: Reference the specific conversation or request that led to the change in the commit body
- Format: Use title for technical change, body for user context and reasoning - Format: Use title for technical change, body for user context and reasoning with clear dialogue markers
- Use dialogue format with "User:" and "Assistant:" or narrative descriptions of the conversation flow
- Examples: - Examples:
``` ```
feat(cli): Add new --no-progress flag feat(cli): Add new --no-progress flag
User requested this for CI environments where progress output User: "Can we disable progress output for CI environments?"
creates noise in build logs. Improves automation compatibility. Assistant: Added --no-progress flag to reduce noise in build logs
and improve automation compatibility.
🤖 Generated with [Claude Code](https://claude.ai/code) 🤖 Generated with [Claude Code](https://claude.ai/code)
@@ -136,9 +138,14 @@ npm run test
``` ```
perf(metrics): Optimize token counting for top files perf(metrics): Optimize token counting for top files
User suggested using character-based pre-filtering with 10x multiplier User: "Is token counting only used for top files display?"
instead of calculating tokens for all files. Reduces computation Assistant: Explained it's used for multiple purposes including total output size
by ~90% while maintaining ranking accuracy for large codebases. User: "Since chars and tokens correlate, why not pre-filter by chars first?"
Assistant: Implemented character-based pre-filtering with 10x multiplier
User: "Can we increase to 10x?" → Changed from 5x to 10x for better accuracy
User: "Change display order to tokens first" → Updated CLI and website
Reduces computation by ~90% while maintaining ranking accuracy.
🤖 Generated with [Claude Code](https://claude.ai/code) 🤖 Generated with [Claude Code](https://claude.ai/code)