git-workflowlisted

# Git-Workflow（git/GitHub 维护） ## Overview 提交与推送要**有范围、有规范、可回滚**：只提交用户要求的内容，提交信息说明"改了什么、为什么"，推送后核对远程状态。**不擅自提交大文件/禁改文件**；每次操作前看 `git status`。 ## When to Use - 编码完成需要提交/推送 - 创建新仓库、设置描述/标签 - 清理仓库状态（误提交、删除文件、gitignore） ## Workflow ### 1. 看状态 ``` git status --short ``` 确认：改了哪些、新增哪些、删除哪些、有没有误进的大文件/产物（OBJ、hex、log）。 ### 2. 定范围 - **只 add 本次相关路径**：`git add <精确路径>`，不要 `git add .` 一把梭。 - 大体积 / 本地专属内容（vendor 资料、视频、构建产物）由 `.gitignore` 排除，确认它们不在待提交列表。 ### 3. 提交 - 信息用祈使句，一行主题 + 必要说明。 - 结尾追加： ``` Co-Authored-By: Claude <noreply@anthropic.com> ``` - 例：`Fix encoder direction sign on left wheel` / `Add wheeltec control port TASK_019` ### 4. 推送 ``` git push origin <branch> git log origin/<branch>..<branch> # 应为空 = 已全部推送 ``` ### 5. 仓库级维护（gh，可选） ``` gh auth status # 未认证先 gh auth login gh repo view <owner>/<repo> # 确认仓库可见 gh repo edit <owner>/<repo> \ --description "<一句说明>" \ --add-topic <topic1> --add-topic <topic2> ``` ### 6. 验证 - `git log origin/main..main` 为空。 - 远程文件清单与预期一致（`gh repo view` 或网页）。 ## 红线 - **只推用户要求的内容**：用户说"只推 skill 和文档"就只推那些。 - **不提交**：构建产物（OBJ/*.axf/*.hex/*.log）、vendor 大资料、本地配置文件（如 `.claude/settings.local.json`）。 - 未经授权不 commit/push；默认分支（main）上直接改要谨慎，大改动先开分支或用 worktree。 ## Common Mistakes | 错误 | 现实 | |------|------| | `git add .` 全加 | 误提交产物/大文件，仓库爆掉 | | 提交信息含糊（"update"） | 无法追溯，后续回滚/审查困难 | | 忘看 status 就 push | 可能把无关改动带上去 | | push 报错直接放弃 | 先 `gh auth status`/`gh auth setup-git` 排查凭据 |