AgentSkillsCN

code-quality

当您检查代码风格、运行 pre-commit 钩子,或在提交更改前确保符合 Google 代码风格指南时,可使用此技能。

SKILL.md
--- frontmatter
name: code-quality
description: Use when checking code style, running pre-commit hooks, or before committing changes to ensure compliance with Google style guide

Code Quality

Code Style

  • Standard: Google C++ Style Guide
  • Line limit: 120 characters
  • Indent: 4 spaces
  • Config: See .clang-format in repo root

Pre-commit Hooks

Setup

bash
pip3 install pre-commit
pre-commit install --hook-type pre-commit --hook-type pre-push

Usage

bash
# Run on staged files
pre-commit run

# Run on specific files
pre-commit run --files src/index/hnsw/hnsw.cc include/knowhere/index/index.h

# Run on all files
pre-commit run --all-files

Commit Workflow

bash
# 1. Make changes
# 2. Run pre-commit on changed files
pre-commit run --files <changed-files>

# 3. Stage and commit
git add .
git commit -m "message"

Common Issues

IssueSolution
Formatting errorsRun clang-format -i <file> or let pre-commit fix it
Line too longBreak line at logical points, max 120 chars
Include orderFollow Google style: related header, C system, C++ standard, other libs, project headers

Pre-commit hooks run automatically on commit. Fix any failures before pushing.