工作流程和版本控制
- 作者仓库星标 0
- 作者仓库 skills-registry
- 领域
- 人工智能
- 作者声明的智能体
- 未找到明确声明;不据此推断已兼容或已测试
- 静态检查
- 88 / 100 · 启发式扫描,不代表运行安全
- 运行环境证据
- 未执行;当前没有隔离运行测试证据
- 作者 / 版本 / 许可证
- @tomevault-io · 未声明许可证
- 上下文用量评级
- 低消耗
- 接入复杂程度
- 需简单配置
- 是否需要外部接口密钥
- 需要 · Vendor-specific
- 兼容的系统
- macOS · Linux · Windows
- 运行环境要求
- 未检出明确要求
- 检测到的文件与系统行为
-
- 只读
- 允许写入 / 修改
- 读取环境变量
- 网络行为
- 允许外网请求
- 安装命令数
- 无(仅作为资料)
需要注意: 未声明工具权限范围;实际权限由运行环境决定。
# Git Workflow and Versioning
## Repo-Specific Workflow
This repo uses `scripts/git-agent.sh` for session-based agent work. The key workflow:
| Step | Command | Description |
|------|---------|-------------|
| Start | `git-agent.sh start <name>` | Creates worktree + branch from main |
| Commit | `git-agent.sh commit -m "msg"` | Stages all, runs quality gate, commits without `--no-verify` |
| End | `git-agent.sh end --pr` | Squashes, pushes branch, creates PR **(required — main is protected)** |
| Abort | `git-agent.sh abort <id>` | Discards worktree and branch |
### Critical Rules (this repo)
- **`end --merge` is NOT supported** on protected branches. The script auto-converts `--merge` to `--pr` when detected.
- **`end --pr` is required** to land changes on `main`. Branch protection enforces PR-only merges.
- **Two-tier commit system:**
- **Checkpoint commits** (during development): Use imperative mood English. Example: `Add validation to registration endpoint`
- **PR merge commits** (permanent history): Use conventional commits. Example: `feat: add validation to registration endpoint`
- **CI must pass** before PRs can merge. Required checks: `Lint & Validate` + `Smoke Tests`.
- **Pre-commit hook** verifies committer identity (`B67687 <111849193+B67687@users.noreply.github.com>`). This runs on every commit (no `--no-verify` except in crash WIP trap).
- **Pre-push hook** verifies all pushed commits have valid SSH signatures.
**Commit-msg hook** at `~/.config/git/hooks/commit-msg` (outside repo — set via `core.hookspath`):
Validates conventional commit format (`feat:`, `fix:`, etc.) and English imperative checkpoint
commits. Only activates for `B67687/agentic-workflows` — pass-through for all other repos.
**Companion script:** `scripts/git-branch-cleanup.sh` --- scans branches for staleness, merge status, and divergence. Run from the skill directory:
```bash
bash ./scripts/git-branch-cleanup.sh scan # all branches
bash ./scripts/git-branch-cleanup.sh stale 5 # branches >5 days old
bash ./scripts/git-branch-cleanup.sh merged # branches merged into main
bash ./scripts/git-branch-cleanup.sh diverged # branches far behind main
```
## Overview
Git is your safety net. Treat commits as save points, branches as sandboxes, and history as documentation. With AI agents generating code at high speed, disciplined version control is the mechanism that keeps changes manageable, reviewable, and reversible.
## When to Use
Always. Every code change flows through git.
## Core Principles
### Trunk-Based Development (Recommended)
Keep `main` always deployable. Work in short-lived feature branches that merge back within 1-3 days. Long-lived development branches are hidden costs --- they diverge, create merge conflicts, and delay integration. DORA research consistently shows trunk-based development correlates with high-performing engineering teams.
```
main ──*──*──*──*──*──*──*──*──*── (always deployable)
╲ ╱ ╲ ╱
*──*─╱ *──╱ <- short-lived feature branches (1-3 days)
```
This is the recommended default. Teams using gitflow or long-lived branches can adapt the principles (atomic commits, small changes, descriptive messages) to their branching model --- the commit discipline matters more than the specific branching strategy.
- **Dev branches are costs.** Every day a branch lives, it accumulates merge risk.
- **Release branches are acceptable.** When you need to stabilize a release while main moves forward.
- **Feature flags > long branches.** Prefer deploying incomplete work behind flags rather than keeping it on a branch for weeks.
### 1. Commit Early, Commit Often
Each successful increment gets its own commit. Don't accumulate large uncommitted changes.
```
Work pattern:
Implement slice -> Test -> Verify -> Commit -> Next slice
Not this:
Implement everything -> Hope it works -> Giant commit
```
Commits are save points. If the next change breaks something, you can revert to the last known-good state instantly.
### 2. Atomic Commits
Each commit does one logical thing:
```
# Good: Each commit is self-contained
git log --oneline
a1b2c3d Add task creation endpoint with validation
d4e5f6g Add task creation form component
h7i8j9k Connect form to API and add loading state
m1n2o3p Add task creation tests (unit + integration)
# Bad: Everything mixed together
git log --oneline
x1y2z3a Add task feature, fix sidebar, update deps, refactor utils
```
### 3. Descriptive Messages
Commit messages explain the *why*, not just the *what*:
```
# Good: Explains intent
feat: add email validation to registration endpoint
Prevents invalid email formats from reaching the database.
Uses Zod schema validation at the route handler level,
consistent with existing validation patterns in auth.ts.
# Bad: Describes what's obvious from the diff
update auth.ts
```
**Format:**
```
<type>: <short description>
<optional body explaining why, not what>
```
**Types:**
- `feat` --- New feature
- `fix` --- Bug fix
- `refactor` --- Code change that neither fixes a bug nor adds a feature
- `test` --- Adding or updating tests
- `docs` --- Documentation only
- `chore` --- Tooling, dependencies, config
### 4. Keep Concerns Separate
Don't combine formatting changes with behavior changes. Don't combine refactors with features. Each type of change should be a separate commit --- and ideally a separate PR:
```
# Good: Separate concerns
git commit -m "refactor: extract validation logic to shared utility"
git commit -m "feat: add phone number validation to registration"
# Bad: Mixed concerns
git commit -m "refactor validation and add phone number field"
```
**Separate refactoring from feature work.** A refactoring change and a feature change are two different changes --- submit them separately. This makes each change easier to review, revert, and understand in history. Small cleanups (renaming a variable) can be included in a feature commit at reviewer discretion.
### 5. Size Your Changes
Target ~100 lines per commit/PR. Changes over ~1000 lines should be split. See the splitting strategies in `code-review-and-quality` for how to break down large changes.
```
~100 lines -> Easy to review, easy to revert
~300 lines -> Acceptable for a single logical change
~1000 lines -> Split into smaller changes
```
## Branching Strategy
### Feature Branches
```
main (always deployable)
│
├── feature/task-creation <- One feature per branch
├── feature/user-settings <- Parallel work
└── fix/duplicate-tasks <- Bug fixes
```
- Branch from `main` (or the team's default branch)
- Keep branches short-lived (merge within 1-3 days) --- long-lived branches are hidden costs
- Delete branches after merge
- Prefer feature flags over long-lived branches for incomplete features
### Branch Naming
```
feature/<short-description> -> feature/task-creation
fix/<short-description> -> fix/duplicate-tasks
chore/<short-description> -> chore/update-deps
refactor/<short-description> -> refactor/auth-module
```
## Working with Worktrees
For parallel AI agent work, use git worktrees to run multiple branches simultaneously:
```bash
# Create a worktree for a feature branch
git worktree add ../project-feature-a feature/task-creation
git worktree add ../project-feature-b feature/user-settings
# Each worktree is a separate directory with its own branch
# Agents can work in parallel without interfering
ls ../
project/ <- main branch
project-feature-a/ <- task-creation branch
project-feature-b/ <- user-settings branch
# When done, merge and clean up
git worktree remove ../project-feature-a
```
Benefits:
- Multiple agents can work on different features simultaneously
- No branch switching needed (each directory has its own branch)
- If one experiment fails, delete the worktree --- nothing is lost
- Changes are isolated until explicitly merged
## The Save Point Pattern
```
Agent starts work
│
├── Makes a change
│ ├── Test passes? -> Commit -> Continue
│ └── Test fails? -> Revert to last commit -> Investigate
│
├── Makes another change
│ ├── Test passes? -> Commit -> Continue
│ └── Test fails? -> Revert to last commit -> Investigate
│
└── Feature complete -> All commits form a clean history
```
This pattern means you never lose more than one increment of work. If an agent goes off the rails, `git reset --hard HEAD` takes you back to the last successful state.
## Change Summaries
After any modification, provide a structured summary. This makes review easier, documents scope discipline, and surfaces unintended changes:
```
CHANGES MADE:
- src/routes/tasks.ts: Added validation middleware to POST endpoint
- src/lib/validation.ts: Added TaskCreateSchema using Zod
THINGS I DIDN'T TOUCH (intentionally):
- src/routes/auth.ts: Has similar validation gap but out of scope
- src/middleware/error.ts: Error format could be improved (separate task)
POTENTIAL CONCERNS:
- The Zod schema is strict --- rejects extra fields. Confirm this is desired.
- Added zod as a dependency (72KB gzipped) --- already in package.json
```
This pattern catches wrong assumptions early and gives reviewers a clear map of the change. The "DIDN'T TOUCH" section is especially important --- it shows you exercised scope discipline and didn't go on an unsolicited renovation.
## Pre-Commit Hygiene
Before every commit:
```bash
# 1. Check what you're about to commit
git diff --staged
# 2. Ensure no secrets
git diff --staged | grep -i "password\|secret\|api_key\|token"
# 3. Run tests
npm test
# 4. Run linting
npm run lint
# 5. Run type checking
npx tsc --noEmit
```
Automate this with git hooks:
```json
// package.json (using lint-staged + husky)
{
"lint-staged": {
"*.{ts,tsx}": ["eslint --fix", "prettier --write"],
"*.{json,md}": ["prettier --write"]
}
}
```
## Handling Generated Files
- **Commit generated files** only if the project expects them (e.g., `package-lock.json`, Prisma migrations)
- **Don't commit** build output (`dist/`, `.next/`), environment files (`.env`), or IDE config (`.vscode/settings.json` unless shared)
- **Have a `.gitignore`** that covers: `node_modules/`, `dist/`, `.env`, `.env.local`, `*.pem`
## Using Git for Debugging
```bash
# Find which commit introduced a bug
git bisect start
git bisect bad HEAD
git bisect good <known-good-commit>
# Git checkouts midpoints; run your test at each to narrow down
# View what changed recently
git log --oneline -20
git diff HEAD~5..HEAD -- src/
# Find who last changed a specific line
git blame src/services/task.ts
# Search commit messages for a keyword
git log --grep="validation" --oneline
```
## Common Rationalizations
| Rationalization | Reality |
|---|---|
| "I'll commit when the feature is done" | One giant commit is impossible to review, debug, or revert. Commit each slice. |
| "The message doesn't matter" | Messages are documentation. Future you (and future agents) will need to understand what changed and why. |
| "I'll squash it all later" | Squashing destroys the development narrative. Prefer clean incremental commits from the start. |
| "Branches add overhead" | Short-lived branches are free and prevent conflicting work from colliding. Long-lived branches are the problem --- merge within 1-3 days. |
| "I'll split this change later" | Large changes are harder to review, riskier to deploy, and harder to revert. Split before submitting, not after. |
| "I don't need a .gitignore" | Until `.env` with production secrets gets committed. Set it up immediately. |
## Red Flags
- Large uncommitted changes accumulating
- Commit messages like "fix", "update", "misc"
- Formatting changes mixed with behavior changes
- No `.gitignore` in the project
- Committing `node_modules/`, `.env`, or build artifacts
- Long-lived branches that diverge significantly from main
- Force-pushing to shared branches
## Verification
For every commit:
- [ ] Commit does one logical thing
- [ ] Message explains the why, follows type conventions
- [ ] Tests pass before committing
- [ ] No secrets in the diff
- [ ] No formatting-only changes mixed with behavior changes
- [ ] `.gitignore` covers standard exclusions
---
> Source: [B67687/agentic-workflows](https://github.com/B67687/agentic-workflows) — distributed by [TomeVault](https://tomevault.io).
<!-- tomevault:4.0:skill_md:2026-05-22 -->
章节与文件索引
按说明文件中的顺序排列。
特定于仓库的工作流程
关键规则(本存储库)
概述
何时使用
基于主干的开发(推荐)
文件/命令 -> scripts/git-agent.sh · git-agent.sh start <name> · git-agent.sh commit -m "msg" · --no-verify · git-agent.sh end --pr · git-agent.sh abort <id> · end --merge · --merge
内容校验值 -> 7807ebc97c20
当前原文的自动摘译,尚未人工审校。
特定于仓库的工作流程
该存储库使用
scripts/git-agent.sh进行基于会话的代理工作。关键工作流程: 步骤 · 命令 · 描述 开始 ·git-agent.sh start <name>· 从主创建工作树 + 分支 提交 ·git-agent.sh commit -m "msg"· 全部暂存,运行质量门,在没有--no-verify的情况下提交 结束 ·git-agent.sh end --pr· 压扁,推送分支,创建 PR(必需 - 主要受保护)关键规则(本存储库)
受保护的分支不支持
end --merge。当检测到时,脚本会自动将--merge转换为--pr。需要end --pr才能在main上进行更改。分支保护强制执行仅 PR 合并。两层提交系统: 检查点提交(开发期间):使用祈使语气英语。示例:Add validation to registration endpointPR 合并提交(永久历史记录):使用常规提交。示例:feat: add validation to registration endpoint概述
Git 是你的安全网。将提交视为保存点,将分支视为沙箱,将历史记录视为文档。随着人工智能代理高速生成代码,严格的版本控制是保持变更可管理、可审查和可逆的机制。
何时使用
总是。每个代码更改都会通过 git 进行。
基于主干的开发(推荐)
保持
main始终可部署。在短暂的功能分支中工作,这些分支会在 1-3 天内合并回来。长期存在的开发分支是隐性成本——它们会产生分歧、产生合并冲突并延迟集成。 DORA 研究一致表明,基于主干的开发与高绩效的工程团队相关。这是推荐的默认值。使用 gitflow 或长期分支的团队可以根据他们的分支模型调整原则(原子提交、小更改、描述性消息)——提交规则比具体的分支策略更重要。