Agent Skills
› NeverSight/learn-skills.dev
› conventional-commits
conventional-commits
GitHub根据暂存区的代码变更生成符合 Conventional Commits 规范的专业提交信息。支持自动识别类型、作用域及主体，正文使用繁体中文描述技术细节，严禁执行 git commit 命令，仅输出格式化文本供用户确认。
Trigger Scenarios
create commit
commit message
git commit
generate commit message
write a commit
commit local repository changes
Install
npx skills add NeverSight/learn-skills.dev --skill conventional-commits -g -y
SKILL.md
Frontmatter
{
"name": "conventional-commits",
"description": "This skill should be used when the user asks to \"create commit\", \"commit message\", \"git commit\", \"generate commit message\", \"write a commit\", \"commit local repository changes\", or describes changes to be committed. Generates high-quality Conventional Commits formatted messages based on staged changes without executing the commit command."
}
Conventional Commits Guidelines
Follow the Conventional Commits specification to generate professional commit messages based on staged changes.
Message Composition Rules
-
Enforce Format:
- Construct the message using the format:
<type>(<scope>): <subject> - Include a blank line followed by a detailed
<body>. Ensure the body reflects technical changes. - Wrap the final output in a Markdown code block.
- Construct the message using the format:
-
Select Appropriate Type:
- Follow the standard types:
feat,fix,docs,style,refactor,perf,test,chore. - Refer to
references/type-definitions.mdfor detailed selection criteria.
- Follow the standard types:
-
Extract Scope (Path-Based Only):
- Derive the scope strictly from the file path of the staged changes.
- Priority 1 (Module): Use the top-level or second-level directory name (e.g.,
src/components/,api/) if all changes fall within it. - Priority 2 (Platform): Use
iosorandroidif changes are specifically inside those folders. - Priority 3 (Global): Use
*only if changes affect more than three top-level modules or involve root-level configuration. - Refer to
references/scope-guidelines.mdfor detailed extraction rules.
-
Compose Subject Line:
- Integrate User Input: Use text provided in quotes verbatim as the
<subject>. Ignore other instructional words in the prompt. - Generate Concisely: Generate a concise subject in Traditional Chinese (Taiwan) based on the staged diff if no text is provided.
- Limit Length: Keep the subject line under 50 characters.
- Integrate User Input: Use text provided in quotes verbatim as the
-
Draft Body Content:
- Analyze Diff: Generate the
<body>exclusively fromgit diff --cachedanalysis. - Prohibit Hallucination: Exclude user instructions, tool metadata, or conversation context.
- Language Policy: Use Traditional Chinese (Taiwan) for descriptions, keeping technical terms in English.
- Requirement: Include a
<body>for every commit. Extract at least one technical bullet point from the git diff even for small changes. - Focus: Describe "what" changed in the code (e.g., modified a function, changed a style property).
- Analyze Diff: Generate the
-
Apply Language Constraints:
type: English.scope: English.subject: Verbatim (if provided) or Traditional Chinese (Taiwan).body: Traditional Chinese (Taiwan) with English technical terms.
-
Handle Staged Changes:
- Analyze ONLY staged changes.
- Stop and inform the user if no changes are staged: "目前沒有已暫存（staged）的變更，請先執行 git add。"
-
Control Output Behavior:
- Follow the strict prohibition on calling tools or functions to execute git commits. Output the generated text only.
- Limit tool usage to
git diff --cachedandgit ls-files.
-
Implement Interactive Refinement:
- Append Refinement Prompt: Append the refinement prompt ONLY during the initial generation (Phase 1):
「💡 提示：若本次改動較複雜，建議提供以下資訊，我將為你潤飾更專業的描述： 背景/動機：(說明為什麼改) 關鍵改動：(說明做了什麼) 預期影響：(說明改完後的好處)」
- Regenerate with Context: Replace the automatically generated body with a polished version if the user provides additional context.
- Maintain Silence: Avoid repeating the refinement prompt in phase 2 (after context is provided).
- Append Refinement Prompt: Append the refinement prompt ONLY during the initial generation (Phase 1):
Operational Workflow
Phase 1: Initial Generation
- Execute
git diff --cachedto gather context. - Stop if no changes are staged.
- Analyze the diff to identify the logical
type. - Determine the scope based on the representative directory name.
- Compose the subject line following priority rules.
- Draft the message text (Subject + Mandatory Body).
- Output the text in a Markdown code block.
- Stop all actions after output. Avoid calling further tools.
- Append the Refinement Prompt.
Phase 2: Contextual Refinement
- Discard the old body if user provides "背景/動機", "關鍵改動", or "預期影響".
- Use the user-provided context as the primary source, supplemented by technical facts from the diff.
- Output the polished commit message in a new code block.
- Stop and do not provide the refinement prompt again.
Additional Resources
Reference Files
references/type-definitions.md- Detailed commit type definitions.references/scope-guidelines.md- Comprehensive scope extraction rules.
Example Files
examples/feature-example.md- Example of a new feature commit.examples/fix-example.md- Example of a bug fix commit.
Version History
- e0220ca Current 2026-07-05 21:39
