Skip to content

项目 GitHub 配置说明

本文档记录了“移动餐车”项目的远程仓库配置及标准化的 GitHub 提交/同步工作流指南,旨在确保项目变更的追溯性与多端协作的一致性。

1. 核心 Git 配置

项目底层使用 Git 进行版本管理,核心连接配置如下:

  • 远程仓库地址 (Remote URL): https://github.com/sdvegeta/ydcc.git
  • 远程仓库名称: origin
  • 默认工作分支: main
  • 配置文件路径: .git/config (本地隐藏目录)

2. 自动化同步工作流 (Standard Operating Procedure)

为了维持 Commit 记录的高质量与业务可理解性,项目通过 .agent/workflows/sync_end.md 定义了闭环同步流程:

第一步:变更分析

在提交前,需评估影响范围:

bash
git status          # 查看文件状态
git diff --stat     # 查看详细变更摘要

第二步:生成规范化提交信息

提交信息必须使用中文,并遵循以下前缀规范:

  • feat: 新增功能/业务架构
  • docs: 文档更新(业务背景、SOP、字段定义等)
  • fix: 修复逻辑漏洞或 UI 问题
  • refactor: 代码/结构重构

示例: docs: 更新 GitHub 配置说明文档

第三步:推送至云端

执行联合指令完成同步:

bash
git add . && git commit -m "规范化中文信息" && git push origin main

3. 常见管理操作

  • 修改仓库地址: git remote set-url origin [新地址]
  • 排除规则: 非业务相关的临时文件(如 .DS_Store)记录在 .gitignore 中。

维护说明: 当业务架构或同步机制发生重大变更时,请同步更新本文档及对应的 /workflows 脚本。