docs(docs): add independent-review developer guide (recommended practice)#1341
Open
jfeng18 wants to merge 3 commits into
Open
docs(docs): add independent-review developer guide (recommended practice)#1341jfeng18 wants to merge 3 commits into
jfeng18 wants to merge 3 commits into
Conversation
…ice) Bilingual (en/zh) recommended review checklist under docs/developer-guide/. Captures the zero-context independent-review discipline plus anolisa-specific review angles (eBPF verifier, arch matrix, FFI/cbindgen, cross-component contract, agent security, packaging). Recommended and optional — complements human CODEOWNERS review + CI, not a gate.
- verify the PR's claimed mechanism against real code, don't trust its abstract terms (e.g. "YAML injection" when there is no YAML parser) - withdraw a finding that doesn't hold up on verification
Keep the discipline abstract; avoid citing a specific incident/PR.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
新增
docs/developer-guide/{en,zh}/independent-review.md——一份推荐的、可选的 anolisa 代码审查 checklist(双语)。它把"不继承作者上下文的独立审查"这套纪律,加上 anolisa 多语言多组件特有的审查角度,沉淀成一份可照着做的清单。Why
CI 能抓机械工具可证明的东西(fmt / clippy / test / coverage / commitlint);单个人工 reviewer 能抓更多,但作者自审时会带着作者的思维框架,审别人时又受限于一个人的盲区。这份 doc 针对的是两者之间的缝隙——linter 和单个 reviewer 都不可靠覆盖的结构 / 正确性 / 安全 / 跨组件问题,尤其是 anolisa 特有、CI 结构上抓不到的角度:
*.bpf.c无自动测试门禁)*.spec.in/component.toml不被 code-test CI 覆盖)和现有机制的关系
想请教落位(cc @casparant)
这是一份 cross-cutting 的方法论 doc,我暂时放在
developer-guide/{en,zh}/顶层。但specs/documentation-standard.md(#1333)里 developer-guide 是"按组件组织",没有为 cross-cutting 的过程类 doc 明确预留位置。请你定该放哪更合适——developer-guide 顶层,还是 CONTRIBUTING / 某个 process 区,或别的?我照调。Testing