菜单
Enforces consistent coding standards across the codebase including naming conventions, code organization, and documentation requirements. Use when writing new code, reviewing pull requests, or refactoring existing code.
用 Codex 或 Claude 帮你安装 复制这段 Prompt，粘贴到 Codex、Claude 或其他助手里，让它检查 Skill 页面并帮你完成安装。
基于 SOC 职业分类
RFC-39 compliant API best practices for Java services. Covers request/response patterns, error handling, pagination, versioning, and authentication standards. Use when designing or reviewing REST APIs in Java services.
RFC-29 compliant changelog management with Common Changelog format and Unreleased section extension. Validates changelog on commits, generates from git history, and ensures all merged PRs are documented. Use when setting up changelog workflows or retrofitting existing repositories.
Systematic workflow for CodeRabbit reviews - local CLI, PR threads, and commit attribution
Database integration patterns for Java services using jOOQ and Flyway. Covers code generation, read/write splitting, migration guidelines, and version compatibility. Use when setting up or maintaining PostgreSQL integration.
Version catalog strategy, dependency management, BOMs, and version constraints for Java/Gradle projects. Covers version centralization, never-downgrade policy, bundle patterns, resolution strategies, and compatibility matrices.
RFC-44 compliant distributed locking patterns for Java services. Covers PostgreSQL advisory locks and Redis-based locking, migration workflows, and common patterns. Use when implementing or migrating distributed locking mechanisms.
| name | coding-standards |
| description | Enforces consistent coding standards across the codebase including naming conventions, code organization, and documentation requirements. Use when writing new code, reviewing pull requests, or refactoring existing code. |
| compatibility | Works with any codebase |
| metadata | {"version":"2.1.0"} |
Enforces consistent naming conventions, code organization, and documentation across the codebase.
📚 references/ - Detailed documentation
🔧 scripts/ - Automation scripts
📦 assets/ - Templates and resources
Run naming convention checks:
# Via skills CLI
node .scripts/skills-cli.ts coding-standards validate
# Programmatically
import { codingStandards } from './.scripts/lib/skills/index.ts';
const result = await codingStandards.validate('./src');
| Language | Convention | Example |
|---|---|---|
| Java | PascalCase for classes | UserService.java |
| Python | snake_case for modules | user_service.py |
| TypeScript/JS | kebab-case or camelCase | user-service.ts |
| Shell | kebab-case | run-tests.sh |
For complete rules, see references/naming-conventions.md.
Scripts are implemented in .scripts/lib/skills/coding-standards.ts:
| Function | Description |
|---|---|
validate(dir) | Run all naming convention checks |
checkNamingConventions(dir) | Check file naming |
checkJavaClass(path) | Validate Java class name |
checkPythonModule(path) | Validate Python module name |
checkTypeScriptFile(path) | Validate TS/JS file name |
| Reference | Description |
|---|---|
| references/naming-conventions.md | Naming rules by language |
| references/code-organization.md | Project structure patterns |
| references/documentation-standards.md | Documentation requirements |
| Asset | Description |
|---|---|
| assets/templates/file-header-template.txt | Standard file header |
quality-checks - Orchestrates coding standards with other quality checksdoc-sync - Documentation synchronization