
conventional-commit
by Cinzya
My personal Quartz blog
SKILL.md
name: conventional-commit description: Creates git commits following project-specific conventional commit conventions for a Quartz blog (content, fix, style, build prefixes) allowed-tools: Bash, Read, Grep
Conventional Commit Skill
This skill helps create properly formatted conventional commits for this Quartz blog repository.
Commit Type Conventions
This project uses the following conventional commit prefixes:
-
content: - For new blog posts or content additions
- Format:
content: [title]orcontent(category): [title] - Example:
content: Introduction to Static Site Generators - Example:
content(tech): Understanding JAMstack Architecture
- Format:
-
fix: - For corrections to existing content or code
- Format:
fix: [what you fixed]orfix(scope): [what you fixed] - Example:
fix: correct typo in about page - Example:
fix(links): update broken external references
- Format:
-
style: - For CSS, layout, or visual changes
- Format:
style: [what you changed]orstyle(component): [what you changed] - Example:
style: improve mobile navigation layout - Example:
style(typography): adjust heading font sizes
- Format:
-
build: - For Quartz generator configuration changes
- Format:
build: [what you changed]orbuild(scope): [what you changed] - Example:
build: enable syntax highlighting plugin - Example:
build(config): update theme colors
- Format:
Instructions
When the user asks you to create a commit:
-
Analyze the changes:
- Run
git statusto see changed/new files - Run
git diffto understand the nature of changes - Identify which commit type applies based on the files changed:
- Files in
content/→ likelycontent:(unless fixing existing posts) - Files ending in
.css,.scss, or style-related →style: - Files like
quartz.config.ts,quartz.layout.ts, plugin configs →build: - Bug fixes or corrections →
fix:
- Files in
- Run
-
Determine the scope (optional but recommended):
- For content: use the content category/folder (e.g.,
tech,personal,about) - For fixes: use the affected area (e.g.,
links,formatting,frontmatter) - For style: use the component/area (e.g.,
typography,navigation,colors) - For build: use the config area (e.g.,
config,plugins,layout)
- For content: use the content category/folder (e.g.,
-
Craft the commit message:
- Use lowercase for the description
- Be concise but descriptive (50 chars or less for the subject)
- Use imperative mood (e.g., "add" not "added")
- If needed, add a body with more details (separated by blank line)
-
Stage and commit:
- Stage relevant files with
git add - Create the commit with the formatted message
- Do NOT include the Claude Code attribution footer for this project
- Stage relevant files with
Examples
New blog post:
git add content/posts/my-new-post.md
git commit -m "content(posts): introduction to quartz"
Fix typo in existing content:
git add content/about.md
git commit -m "fix(about): correct university name"
Update CSS styling:
git add quartz/styles/custom.scss
git commit -m "style(typography): increase body font size for readability"
Modify Quartz configuration:
git add quartz.config.ts
git commit -m "build(config): enable LaTeX plugin and update theme"
Multiple file changes with body:
git add content/posts/*.md
git commit -m "content(posts): add three new articles on web development
- Introduction to React hooks
- CSS Grid vs Flexbox comparison
- Modern JavaScript features overview"
Important Notes
- Always run
git statusandgit difffirst to understand what's being committed - Do NOT add the "🤖 Generated with Claude Code" footer to commits in this repository
- If the user's changes span multiple types, ask which aspect they want to commit first or suggest breaking it into multiple commits
- For unclear cases, ask the user which commit type they prefer
- Never commit files that contain secrets (.env, credentials, etc.)
Score
Total Score
Based on repository quality metrics
SKILL.mdファイルが含まれている
ライセンスが設定されている
100文字以上の説明がある
GitHub Stars 100以上
3ヶ月以内に更新がある
10回以上フォークされている
オープンIssueが50未満
プログラミング言語が設定されている
1つ以上のタグが設定されている
Reviews
Reviews coming soon