| name | commit-preparation |
| description | 在发布commit前执行检查清单，包括gitignore验证、改动总结、ChangeLog更新与标准格式commit。关键词：commit前检查、gitignore、ChangeLog、commit格式、版本管理。 |
Commit前检查清单
目标
在提交代码到仓库前，确保代码质量、文档完整性、隐私安全与提交规范。
步骤
1. 检查 .gitignore 合规性
验证 .gitignore 包含以下必要项：
- Python运行时：
__pycache__/, *.pyc, *.pyo, *.egg-info, build/, dist/, wheels/
- 虚拟环境：
.venv, venv/, env/
- 隐私配置：
.last_config_path（用户配置缓存），API快捷配置文件
- 测试缓存：
.pytest_cache/, .coverage
- 运行时数据：
data/（本地测试数据与会话记录）
- IDE：
.vscode/, .idea/, *.swp, *.swo
- 环境：
.env, .env.local（若使用环境变量管理密钥）
操作指南：
cat .gitignore
git status --short
git diff --cached --name-only
检查清单：
2. 总结近期改动
列出此次提交涉及的改动范围：
git log --oneline v0.1.0..HEAD
git diff --cached --stat
改动摘要应包含：
- 新增功能（Feature）
- 问题修复（Fix）
- 代码优化/重构（Refactor）
- 文档更新（Docs）
- 依赖变更（Chore）
示例摘要：
- feat: 实现日记索引模块（memory/diary/indexer.py、memory/diary/retriever.py）
- feat: 新增智能遗忘引擎与衰退调度
- test: 添加8个记忆质量系统测试（79/79通过）
- docs: 更新architecture.md中的Phase 2记忆系统说明
- chore: 增强.gitignore覆盖范围
3. 更新 ChangeLog
编辑 CHANGELOG.md，按以下格式新增条目：
格式 (Keep a Changelog 规范)：
## [Unreleased]
### Added
- 新增功能描述
### Changed
- 修改功能描述
### Fixed
- 修复问题描述
### Deprecated
- 弃用功能描述（可选）
---
## [0.1.0] - 2026-04-05
### Added
- 初始版本发布：多人角色扮演编排引擎
- 支持OpenAI兼容接口与SiliconFlow适配
- 动态群聊模式与记忆管理系统
操作指南：
检查清单：
4. 按标准格式发布Commit
使用 Conventional Commits 规范：
<type>(<scope>): <subject>
<body>
<footer>
Type 列表：
feat: 新功能fix: 问题修复refactor: 代码重构（无功能变化）test: 测试相关docs: 文档更新chore: 依赖、构建、工具等杂项perf: 性能优化
Scope (可选,但推荐)：
- 受影响的模块名，如
memory, provider, cli, tests
Subject：
- 使用祈使句，第一个单词大写
- 中英文需统一：项目已使用中文，commit须全中文
- 不超过50个字符
Body (可选，但对重要改动必需)：
- 解释何为改动、为何改动、与之前行为的区别等
- 每行不超过72个字符
Footer (可选)：
- 关闭相关issue：
Closes #123
- 破坏性变更说明：
BREAKING CHANGE: 详细说明
提交示例：
git commit -m "feat(memory): 实现记忆质量评估与智能遗忘引擎
新增sirius_pulse/memory/diary/indexer.py模块，包含：
- DiaryIndexer：关键词 + EmbeddingClient 向量索引
- DiaryRetriever：按 token 预算检索相关日记
新增sirius_pulse/memory/diary/retriever.py，提供检索工具：
- retrieve: 按查询检索适配 prompt 的日记列表
- search: 关键词/向量混合搜索
整合到DiaryManager：add()、search()、retrieve()
Closes #234"
git commit -m "fix(provider): 修复SiliconFlow API响应超时处理
之前在网络波动时未正确捕获超时异常，导致会话中断。
现在使用exponential backoff重试机制，重试次数配置为3次。"
git commit -m "docs(architecture): 补充Phase 2记忆质量系统说明
新增记忆质量评估与智能遗忘章节，包含：
- 评分算法与时间衰退机制
- CLI使用示例与集成方式
- 内部参数常量说明"
git commit -m "chore(gitignore): 增强隐私文件覆盖范围"
Commit前最终检查：
快速执行流程
cat .gitignore | grep -E "(__pycache__|\.venv|data/|\.last_config_path)"
git diff --cached --stat
git commit -m "feat(memory): 实现记忆质量评估与智能遗忘
[详细描述...]"
git log --oneline -1
失败条件
.gitignore 未包含隐私文件或运行时缓存。- 暂存区包含敏感文件（API密钥、个人配置等）。
- Commit message不遵循Conventional Commits规范。
- 使用了英文commit message（违反项目中文约定）。
- 测试失败（執行
pytest -q 返回非0）。
- 重要改动未在CHANGELOG.md中说明。
备注
- 隐私优先：任何个人配置、API密钥、会话数据须确保已忽略。
- 可追溯性：每个commit应包含充分信息，便于查阅历史与审计。
- 团队协作：使用统一格式便于自动化工具解析与变更日志生成。
