Skip to content

docs(planning): tag REQ-* with P0/P1/P2 priorities + add OPEN_QUESTIONS - #394

Merged
AlexStocks merged 3 commits into
mainfrom
feat/planning-req-priorities
Jul 30, 2026
Merged

docs(planning): tag REQ-* with P0/P1/P2 priorities + add OPEN_QUESTIONS#394
AlexStocks merged 3 commits into
mainfrom
feat/planning-req-priorities

Conversation

@AlexStocks

@AlexStocks AlexStocks commented Jul 30, 2026

Copy link
Copy Markdown
Contributor

背景

PRD 审计(deliverables/software-company/kiwi-prd-audit-2026-07-30.md)指出 .planning/REQUIREMENTS.md 的 61 条 REQ-* 缺少统一优先级,且项目缺少一份集中的"待确认问题"清单。本 PR 补齐这两项 P2 治理缺口(均为文档,不触碰任何源码/CI/构建)。

改动

  • .planning/REQUIREMENTS.md
    • 为全部 61 条 REQ-* bullet 追加行内 {priority: P0|P1|P2} 标签(P0×30 / P1×11 / P2×20)。判定口径:P0=当前产品核心/不可协商;P1=质量与可观测深度;P2=未来派生/延期热层(冻结中,未授权实现)。
    • 文件头新增一行图例,解释优先级含义,避免标签变成噪音。
  • .planning/OPEN_QUESTIONS.md(新增):集中收录 10 项当前未闭合、需 owner/决策/证据才能推进的问题,每项锚定到真实 issue 或 REQ-*:热层解冻门禁、许可证边界(Apache-2.0 vs AGPL-3.0)、Redis 兼容版本矩阵、TOML 配置、StreamAppend RPC、Engine trait 处置、存储格式版本与迁移、实例拓扑持久化、双 Runtime RFC、统一测试策略。附维护规则(结论落 DECISIONS.md,并从本清单移除)。

验证

  • 完整性核对:grep -cE '^\s*-\s*\REQ-'= 61,与priority:` 标签数 61 一致,全部 bullet 均已标注。
  • 仅修改/新增 .planning/ 治理文档,工作区其余文件(.omx/.workbuddy/deliverables/)未纳入。

注意

Summary by CodeRabbit

  • 文档
    • 新增开放问题清单,集中记录待确认事项、责任归属、决策依据及后续同步规则。
    • 为验收需求补充 P0、P1、P2 优先级标识,帮助团队明确核心能力、质量改进与延期事项的处理顺序。
    • 补充 Redis 兼容性、存储迁移、安全启动、测试策略等主题的跟进事项。

- Annotate all 61 REQ-* bullets with an inline {priority: P0|P1|P2}
  tag and add a legend line in the header (P0=current core, P1=quality/
  observability depth, P2=deferred/frozen hot-tier derivatives).
- Add .planning/OPEN_QUESTIONS.md to centralize unresolved decisions
  (hot-tier unfreeze gate, license boundary, Redis version matrix, TOML
  config, StreamAppend RPC, Engine trait disposal, format-version/migration,
  topology persistence, dual-runtime RFC, unified test strategy), each
  anchored to a real issue/REQ.

Closes #389 is unrelated; this closes the P2 governance gaps noted in the
PRD audit (add REQ priorities + a consolidated open-questions registry).
@coderabbitai

coderabbitai Bot commented Jul 30, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

本次变更更新规划治理文档:为所有验收需求补充 P0/P1/P2 优先级,并新增包含 OQ-1 至 OQ-10 及维护流程的开放问题清单。

Changes

规划治理

Layer / File(s) Summary
验收需求优先级标注
.planning/REQUIREMENTS.md
定义 P0、P1、P2 优先级语义,并为 Redis 兼容、存储、稳定性、热层、Raft、许可证、可观测性和工作连续性条目补充优先级。
开放问题登记与处置规则
.planning/OPEN_QUESTIONS.md
新增 OQ-1 至 OQ-10 待确认事项,以及状态标注、阻塞条件填写和结论同步更新规则。

Estimated code review effort: 1 (Trivial) | ~5 minutes

Possibly related PRs

  • arana-db/kiwi#371:同样修改 .planning/REQUIREMENTS.md,涉及 Redis 8.8.1 稳定性门禁范围。
  • arana-db/kiwi#383:同样修改 .planning/REQUIREMENTS.md,细化 Redis 兼容性与工作连续性验收条款。
🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description explains the doc changes well, but it doesn't follow the repository's required template sections. Add the template headings (Description, Type of Change, Checklist, Testing, Additional Context) and include a Fixes # reference.
✅ Passed checks (4 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Title check ✅ Passed The title is concise and accurately summarizes the planning docs changes.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feat/planning-req-priorities

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

Comment thread .planning/REQUIREMENTS.md Outdated
Comment thread .planning/OPEN_QUESTIONS.md Outdated
Comment thread .planning/OPEN_QUESTIONS.md Outdated
Comment thread .planning/OPEN_QUESTIONS.md Outdated
Align the priority model and open-question lifecycle with accepted D001, D002, and D005 so future planning work cannot treat fixed baselines as undecided.

Constraint: Limit this follow-up to PR #394 planning priorities and open-question semantics.

Rejected: Delete resolved sections entirely | It would remove tracking for still-required license review and Redis 8.8.1 compatibility gates.

Confidence: high

Scope-risk: narrow

Tested: git diff --cached --check; 61 unique requirement IDs and priorities; 10 complete OPEN question records; LF line endings.

Not-tested: No Rust build or runtime test was run because this follow-up changes planning Markdown only; new remote CI is pending after push.

Co-authored-by: OmX <omx@oh-my-codex.dev>

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In @.planning/OPEN_QUESTIONS.md:
- Around line 55-60: Update OQ-10’s first “待确认” bullet to reference OQ-3 as the
authoritative question for the Redis 8.8.1 Oracle fast-gate/full-gate split,
removing the duplicated decision wording while leaving the remaining bullets
unchanged.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 122cd679-e7b8-4e75-acbe-87d524083cc0

📥 Commits

Reviewing files that changed from the base of the PR and between 9102a6d and 39798ca.

📒 Files selected for processing (2)
  • .planning/OPEN_QUESTIONS.md
  • .planning/REQUIREMENTS.md

Comment thread .planning/OPEN_QUESTIONS.md
Make OQ-3 the sole decision point for Redis 8.8.1 gate layering while OQ-10 consumes that result as an input to the broader test strategy.

Constraint: Limit this follow-up to the current CodeRabbit finding on PR #394.

Rejected: Repeat the gate split in OQ-10 | Two writable descriptions can drift into conflicting planning decisions.

Confidence: high

Scope-risk: narrow

Tested: git diff --cached --check; OQ section structure and single-source assertions; LF line endings.

Not-tested: No Rust build or runtime test was run because this follow-up changes one planning Markdown line; new remote CI is pending after push.

Co-authored-by: OmX <omx@oh-my-codex.dev>
@AlexStocks
AlexStocks merged commit 1f67524 into main Jul 30, 2026
20 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant