
smith-style
by tianjianjiang
AGENTS.md as dotfiles: Personal coding standards that follow you everywhere, Mr. Anderson.
SKILL.md
name: smith-style description: File naming, path standards, and conventional commits. Use when naming files, creating branches, writing commit messages, or setting up new projects. Covers underscore vs hyphen conventions, commit format, and branch naming patterns.
File Naming & Path Standards
- Load if: Git operations, PR workflows, new project setup
- Prerequisites: @smith-principles/SKILL.md
CRITICAL: Naming Separators (Primacy Zone)
Underscore (_): Multi-word phrases as single concept
user_authentication,query_processor,semantic_search- Think: "What kind of X?" → underscore
Hyphen (-): Hierarchical/parallel relationships
auth-login(login is part of auth)api-restvsapi-graphql(variants)- Dates:
2025-01-15 - Tickets:
JIRA-1234
File Patterns
Test files: test_[module]_[function]_[type].py
JSON test data: [module]_[function]_cases.json
Documentation: [topic].md (hyphen for hierarchy, underscore for phrases)
Config: .env, pyproject.toml, AGENTS.md
Path References
Use code blocks, not Markdown links:
**Core Principles**: @smith-principles/SKILL.md - Description
**Related Skill**: @skill-name/SKILL.md - Description
Variables: $WORKSPACE_ROOT, $REPO_ROOT, $HOME
Conventional Commits
Format: type: description or type(scope): description
Types: feat, fix, docs, refactor, style, test, chore, perf, build, ci
Length limits (50/72 rule):
- Subject: 50 chars target, 72 max
- Body: 72 chars per line
feat(auth): add token refresh
fix: resolve CORS issues
docs: update deployment guide
- Subject over 72 characters
- Multiple unrelated changes ("add X and fix Y")
- Using
docswhen also changing code
Branch Names
Pattern: type/descriptive_name
Examples:
feat/user_authentication(underscore: single concept)feat/auth-login(hyphen: login is part of auth)fix/JIRA-1234-query_processor
Branch type MUST match commit type
feat/user-authentication(should be underscore)feat/auth_login(should be hyphen)
@smith-git/SKILL.md- Branch and commit workflows- @smith-principles/SKILL.md - Core principles (DRY, KISS, YAGNI)
ACTION (Recency Zone)
Before naming:
- Is it a single concept? → underscore
- Is it a part/variant? → hyphen
- Is it a date/ticket? → hyphen
Before committing:
- Subject ≤72 chars?
- Single atomic change?
- Type matches branch?
スコア
総合スコア
リポジトリの品質指標に基づく評価
SKILL.mdファイルが含まれている
ライセンスが設定されている
100文字以上の説明がある
GitHub Stars 100以上
3ヶ月以内に更新がある
10回以上フォークされている
オープンIssueが50未満
プログラミング言語が設定されている
1つ以上のタグが設定されている
レビュー
レビュー機能は近日公開予定です