docs(contributing): add omitted packages to Project Structure - #1446
Frank-zhu0404 wants to merge 4 commits into
Conversation
|
✅ OpenCodeReview: Review skipped: no items were selected. |
Qiyuanqiii
left a comment
Qiyuanqiii
left a comment
There was a problem hiding this comment.
Looks good to me.
I checked the updated Project Structure against the PR head: the newly documented entries cover the currently omitted top-level internal/ packages, and the descriptions are consistent with their actual responsibilities (including mcp, scan, suggestdiff, pathutil, and the release asset naming checks). The same structure update is also kept in sync across the English, ja-JP, ko-KR, ru-RU, and zh-CN contributing guides.
I don't see any blocking documentation accuracy or consistency issues here.
This review was conducted by Qiyuanqiii's review bot, using the model GPT-5.6 Sol. If you need a human review, please manually @Qiyuanqiii.
|
@wu21-web Yes — both are top-level directories at the repo root ( |
wu21-web
left a comment
wu21-web
left a comment
There was a problem hiding this comment.
Those claims are incorrect. The scripts/ is just a folder of javascripts to do operations, like check some code or posting comments to the web. Please check before submission.
|
@Frank-zhu0404 These comments above must be addressed before merging. |
|
@wu21-web Both review comments are addressed in
Please re-check when you have a moment — happy to adjust further if anything is still off. |
|
@Frank-zhu0404 rebase main |
pages/ is the deployed documentation site, not a WebUI frontend. scripts/ was mislabeled and is removed from the Project Structure tree per maintainer review.
- pages/: Deployed documentation (not viewer WebUI) - scripts/: Web operations & chore Rebased onto upstream/main.
0fc349e to
e200dfd
Compare
|
@wu21-web Rebased onto |
| ├── internal/ | ||
| │ ├── agent/ # Review agent logic | ||
| │ ├── config/ # Configuration management | ||
| │ ├── delegate/ # Delegation-mode spec generation | ||
| │ ├── diff/ # Git diff parsing | ||
| │ ├── gitcmd/ # Git subprocess runner | ||
| │ ├── llm/ # LLM API client (Anthropic & OpenAI) | ||
| │ ├── llmloop/ # Shared LLM tool-use loop | ||
| │ ├── mcp/ # MCP client and tool registration | ||
| │ ├── model/ # Data models | ||
| │ ├── pathutil/ # Path canonicalization and containment | ||
| │ ├── release/ # Release asset naming checks | ||
| │ ├── scan/ # Full-file scan (ocr scan) | ||
| │ ├── session/ # Review session management | ||
| │ ├── tool/ # Built-in tools (file_read, code_search, etc.) | ||
| │ ├── stdout/ # Stdout quiet/redirect helper | ||
| │ ├── suggestdiff/ # Line-level suggestion diffs for CLI | ||
| │ ├── telemetry/ # OpenTelemetry integration | ||
| │ ├── tool/ # Built-in tools (file_read, code_search, etc.) | ||
| │ └── viewer/ # WebUI session viewer | ||
| ├── pages/ # WebUI frontend | ||
| ├── scripts/ # Build & install scripts | ||
| ├── pages/ # Deployed documentation | ||
| ├── scripts/ # Web operations & chore | ||
| └── bin/ # NPM wrapper |
There was a problem hiding this comment.
Why are these lines not translated into Korean at all?
| ├── pages/ # WebUIフロントエンド | ||
| ├── scripts/ # ビルド & インストールスクリプト | ||
| ├── pages/ # デプロイ済みドキュメント | ||
| ├── scripts/ # Web operations & chore |
There was a problem hiding this comment.
Clearly you can use a translator to get this line translated too.
4 participants
Description
Updates the Project Structure section in
CONTRIBUTING.md(and synced i18n copies) so it lists packages that already exist underinternal/but were omitted from the tree diagram:delegate,gitcmd,llmloop,mcp,pathutil,release,scan,stdout, andsuggestdiff.Type of Change
How Has This Been Tested?
Verified each added package directory exists under
internal/and that the four i18n CONTRIBUTING copies mirror the English structure additions.make testpasses locallyCompared package names against
internal/*layout; confirmed alphabetical ordering and i18n parity for ja-JP / ko-KR / ru-RU / zh-CN.Checklist
go fmt,go vet)AI disclosure: assisted by Grokbuild (Grok 4.6) for drafting the CONTRIBUTING tree update; human-reviewed every line and verified packages against the real
internal/layout. Codex (gpt-5.6-sol) used for read-only review only (VERDICT=PASS). No AI commit trailers.Related Issues
closes #1441