engram-branch-pr

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

When to Use

使用场景

Use this skill when:
  • Starting a new feature, fix, or refactor
  • Splitting work into multiple PRs
  • Preparing a PR for review and merge

当你需要以下操作时使用此技能:
  • 启动新功能、修复或重构工作
  • 将工作拆分为多个PR
  • 准备PR以进行评审和合并

Core Rules

核心规则

  1. Create a focused branch (
    feat/*
    ,
    fix/*
    ,
    chore/*
    ).
  2. Keep one logical scope per branch.
  3. Push early and often to avoid large risky diffs.
  4. Open PRs with intent, risk, and validation evidence.
  5. Do not mix unrelated changes in the same PR.

  1. 创建聚焦的分支(
    feat/*
    fix/*
    chore/*
    )。
  2. 每个分支保持单一逻辑范围。
  3. 尽早并频繁推送代码,避免产生大而有风险的差异。
  4. 提交PR时说明意图、风险和验证依据。
  5. 请勿在同一个PR中混合无关的变更。

PR Structure

PR结构

Include:
  • Problem statement (why this change exists)
  • Solution summary (what changed)
  • Risk notes (what could break)
  • Validation (tests/commands executed)
  • Follow-ups (what is intentionally out of scope)

需包含:
  • 问题说明(此变更的原因)
  • 解决方案概述(变更内容)
  • 风险提示(可能受影响的部分)
  • 验证信息(执行的测试/命令)
  • 后续工作(明确不属于当前范围的内容)

Merge Checklist

合并检查清单

  • Branch name matches scope
  • Diff is focused and reviewable
  • Tests relevant to the change pass
  • No temporary files or local artifacts included
  • PR description explains why, not only what
  • 分支名称与范围匹配
  • 代码差异聚焦且便于评审
  • 与变更相关的测试全部通过
  • 未包含临时文件或本地构建产物
  • PR描述解释了变更原因,而非仅说明变更内容