mirror of
https://github.com/ZhuLinsen/daily_stock_analysis
synced 2026-09-20 10:53:33 +08:00
chore: remove one-off PR screenshot assets (#1625)
* chore: remove one-off PR screenshots * chore: remove one-off issue screenshots
This commit is contained in:
@@ -19,6 +19,7 @@
|
||||
- 新增配置项时,必须同步更新 `.env.example` 和相关文档。
|
||||
- 涉及用户可见能力、CLI/API 行为、部署方式、通知方式、报告结构变化时,必须同步更新相关文档与 `docs/CHANGELOG.md`。
|
||||
- 修改报告格式、报告渲染效果或 Web UI 界面时,PR 描述必须附受影响报告 / 页面截图;涉及前后差异时优先附前后对比,无法截图时说明原因与替代可视证据。
|
||||
- Issue / PR 过程截图、审查截图、一次性验收截图和临时可视证据不得作为仓库文件合入;应放在 PR 描述、PR 评论、GitHub 附件、Actions artifact 或外部可访问证据链接中。产品长期文档确需保留的示意图除外,但文件名和文档语义必须脱离具体 issue / PR 编号。
|
||||
- `docs/CHANGELOG.md` 的 `[Unreleased]` 段使用**扁平格式**:每条独立一行,格式为 `- [类型] 描述`,类型取值:`新功能`/`改进`/`修复`/`文档`/`测试`/`chore`;**禁止在 `[Unreleased]` 内新增 `### 类目标题`**,以减少并发 PR 的 merge 冲突。发版时由 maintainer 汇总整理成带标题的正式格式。
|
||||
- `README.md` 只用于项目定位、核心能力总览、快速开始、主要入口、赞助/合作等首页级信息;非必要不更新 README,避免持续膨胀。
|
||||
- 更细的模块行为、页面交互、专题配置、排障说明、字段契约、实现语义和边界条件,优先更新对应 `docs/*.md` 或专题文档,不写入 README。
|
||||
|
||||
Reference in New Issue
Block a user