界面已本地化;技能介绍与说明文档按所选语言由 AI 自动翻译,代码、命令、路径和专业术语保留原文,以原作者文档为准。
探索技能
开发与工程 · SKILL.md

pr-submission

pr-submission

【开发与工程】PR title format, commit conventions, and pre-PR checklist for SkillHub. Use when preparing or reviewing pull requests.

独立 GitHub 快照 · 自动分类 · 以原作者文档为准

Iiflytek / skillhubApache-2.0

技能说明

GitHub

name: pr-submission description: PR title format, commit conventions, and pre-PR checklist for SkillHub. Use when preparing or reviewing pull requests. license: Apache-2.0

PR Submission Skill

Workflow

  1. Identify the scope of your change (feature, bug fix, docs, test, refactor, chore)
  2. Format PR title and commits using the conventions below
  3. Run the pre-PR checklist commands
  4. Open the PR with a descriptive body

PR Title Format

Use conventional commit style:

<type>(<scope>): <description>

Types:

TypeWhen to Use
featNew feature or capability
fixBug fix
docsDocumentation changes only
testAdding or updating tests
refactorCode restructuring with no behavior change
choreBuild, CI, tooling, or maintenance tasks

Scopes: Use module or domain names: auth, search, publish, review, namespace, governance, deploy, ci, frontend, scanner

Examples:

feat(auth): add local account login with password reset
fix(publish): resolve null pointer when skill metadata is missing name
docs(deploy): clarify runtime image usage
test(namespace): add membership service edge case tests
refactor(review): extract query repository for governance list
chore(ci): add parallel workflow scripts for multi-agent development

Commit Message Format

Same convention as PR titles. One logical change per commit.

Types:

  • feat: A new feature for the user
  • fix: A bug fix for the user
  • docs: Documentation changes only
  • test: Adding or updating tests
  • refactor: Code change that neither fixes a bug nor adds a feature
  • chore: Changes to build process, CI, or maintenance tasks

Examples:

fix(auth): resolve session cookie conflict in device flow
feat(publish): support security scan before review submission
docs(skill-protocol): add nested SKILL.md discovery rules
test(search): verify jieba analysis with Chinese skill descriptions
refactor(storage): simplify LocalFile path normalization

Pre-PR Checklist

  • Backend tests pass: make test-backend-app
  • Frontend typecheck passes: make typecheck-web
  • If API changed: make generate-api was run and web/src/api/generated/schema.d.ts is committed
  • Smoke test passes: make staging
  • Follow existing module boundaries and dependency direction
  • Add/update tests for new behavior
  • Update design docs when APIs, auth flows, deployment, or operator workflows change

PR Body Structure

When creating a PR, include:

  1. What — Summary of the change
  2. Why — Motivation (link to issue if applicable)
  3. How — Key implementation details (especially for non-obvious decisions)
  4. Testing — How to verify the change works
  5. Impact — Breaking changes, migration notes, or rollout considerations

Review Conventions

  • When reviewing, cite the specific AGENTS.md rule that applies if suggesting a convention change
  • For backend code, check dependency direction does not violate clean architecture rules
  • For frontend code, check OpenAPI types are regenerated if API changed
我的收藏