mirror of
https://github.com/ZhuLinsen/daily_stock_analysis
synced 2026-09-20 10:53:33 +08:00
docs: require screenshots for visual PR changes (#1613)
This commit is contained in:
@@ -45,6 +45,7 @@ gh run view <run_id> --log-failed
|
||||
- `Scope Of Change`
|
||||
- `Issue Link`
|
||||
- `Verification Commands And Results`
|
||||
- `Visual Evidence`(仅当 PR 修改报告格式、报告渲染效果或 Web UI 界面时要求截图或替代可视证据)
|
||||
- `Compatibility And Risk`
|
||||
- `Rollback Plan`
|
||||
|
||||
@@ -56,6 +57,8 @@ gh run view <run_id> --log-failed
|
||||
- 旧配置是否会被静默改写、清空、迁移或保持不变
|
||||
- 最小回滚路径(通常是 revert 本 PR)
|
||||
|
||||
若 PR 修改报告格式、报告渲染效果或 Web UI 界面,还要检查 `Visual Evidence` 是否附受影响报告 / 页面截图;涉及前后差异时优先检查前后对比。若无法截图,描述中应说明原因与替代可视证据。
|
||||
|
||||
### Step 3: 优先使用 CI / Diff 证据
|
||||
|
||||
- 先根据 `gh pr checks`、PR diff、现有测试与工作流日志判断问题
|
||||
|
||||
9
.github/PULL_REQUEST_TEMPLATE.md
vendored
9
.github/PULL_REQUEST_TEMPLATE.md
vendored
@@ -42,6 +42,14 @@ python -m pytest -m "not network"
|
||||
|
||||
关键输出/结论 / Key output & conclusion:
|
||||
|
||||
## Visual Evidence (if applicable)
|
||||
|
||||
若本 PR 修改报告格式、报告渲染效果或 Web UI 界面,请在此处附受影响报告 / 页面截图;涉及前后差异时,优先附前后对比。
|
||||
*(EN) If this PR changes report formatting, report rendering, or Web UI, attach screenshots of the affected report/page here; before/after screenshots are preferred when relevant.)*
|
||||
|
||||
- 截图 / Screenshots:
|
||||
- 不适用原因 / Reason if not applicable:
|
||||
|
||||
## Compatibility And Risk
|
||||
|
||||
请说明兼容性影响、潜在风险(如无请写 `None`)。
|
||||
@@ -82,4 +90,5 @@ python -m pytest -m "not network"
|
||||
- [ ] 已提供可复现的验证命令与结果 / Reproducible verification commands and results are included
|
||||
- [ ] 已评估兼容性与风险 / Compatibility and risk have been assessed
|
||||
- [ ] 已提供回滚方案 / A rollback plan is provided
|
||||
- [ ] 若修改报告格式或 Web UI 界面,已附受影响报告 / 页面截图 / If report formatting or Web UI changed, affected report/page screenshots are attached
|
||||
- [ ] 若涉及用户可见变更,已同步更新相关文档与 `docs/CHANGELOG.md`;`README.md` 仅在首页级信息变化时更新,细节优先写入 `docs/*.md` / If user-visible changes are included, relevant docs and `docs/CHANGELOG.md` are updated; `README.md` is updated only for homepage-level changes, with details kept in `docs/*.md`
|
||||
|
||||
@@ -18,6 +18,7 @@
|
||||
- 默认稳定性优先于“顺手优化”;非当前任务直接需要的重构、抽象和基础设施迁移一律克制。
|
||||
- 新增配置项时,必须同步更新 `.env.example` 和相关文档。
|
||||
- 涉及用户可见能力、CLI/API 行为、部署方式、通知方式、报告结构变化时,必须同步更新相关文档与 `docs/CHANGELOG.md`。
|
||||
- 修改报告格式、报告渲染效果或 Web UI 界面时,PR 描述必须附受影响报告 / 页面截图;涉及前后差异时优先附前后对比,无法截图时说明原因与替代可视证据。
|
||||
- `docs/CHANGELOG.md` 的 `[Unreleased]` 段使用**扁平格式**:每条独立一行,格式为 `- [类型] 描述`,类型取值:`新功能`/`改进`/`修复`/`文档`/`测试`/`chore`;**禁止在 `[Unreleased]` 内新增 `### 类目标题`**,以减少并发 PR 的 merge 冲突。发版时由 maintainer 汇总整理成带标题的正式格式。
|
||||
- `README.md` 只用于项目定位、核心能力总览、快速开始、主要入口、赞助/合作等首页级信息;非必要不更新 README,避免持续膨胀。
|
||||
- 更细的模块行为、页面交互、专题配置、排障说明、字段契约、实现语义和边界条件,优先更新对应 `docs/*.md` 或专题文档,不写入 README。
|
||||
|
||||
Reference in New Issue
Block a user