Skip to content

docs(tooling): translate build/CI, scripts, and pragent-shim comments/logs to English - #188

Merged
huhamhire merged 1 commit into
devfrom
docs/comments-tooling
Jul 5, 2026
Merged

docs(tooling): translate build/CI, scripts, and pragent-shim comments/logs to English#188
huhamhire merged 1 commit into
devfrom
docs/comments-tooling

Conversation

@huhamhire

Copy link
Copy Markdown
Owner

What & why

The final layer of the code-comment English initiative — the build/tooling/CI + pragent-shim files my src/-focused passes skipped. Completes the "developer-facing code-surface artifacts are English" convention across the whole repo. Follows #184 (packages), #185 (renderer), #186 (backend), #187 (styles).

Scope (22 files)

  • CI / build config: .github/workflows/{ci-cli,release}.yml, apps/desktop/electron-builder.yml, electron.vite.config.ts, build-resources/after-pack.cjs, scripts/assemble-pragent-runtime.mjs
  • pragent-shim (the non-invasive pr-agent monkeypatch subsystem): 14 Python files (comments + docstrings)
  • .gitignore comments (root + shim)

Beyond comments/docstrings, the developer-facing log/error output strings in the dev scripts are also translated (per the logs/exceptions-in-English convention): assemble-pragent-runtime.mjs log/fail output, shim RuntimeError/_debug/_warn messages, after-pack.cjs logs.

Also fixes a stale doc path in .gitignore (docs/modules/04-…docs/arch/02-agent/05-pragent-runtime.md).

Left verbatim

Functional string literals: LLM prompt/instruction text, config/dict keys, YAML keys, sentinel tokens (@@MEEBOX_USAGE@@, meebox:///, LOCAL__*), regex, and strings matched against upstream pr-agent/litellm messages. .github/ISSUE_TEMPLATE/*.yml (user-facing issue-form content, not comments) is out of scope.

Verification

  • node --check (mjs/cjs), py_compile (14 shim files), and YAML parse all pass.
  • prepare:pragent re-synced the shim and the smoke test passes (pr_agent importable + shim patch active) — the definitive check for the shim changes; its own console output is now English too.

Wrap-up

With this, all Chinese code comments across apps/desktop (src + styles + tooling), packages/, tools/, typings/, and the shim are English. The Go CLI was already English.

Final code-comment layer (22 files): CI workflows, electron-builder.yml,
electron.vite.config.ts, after-pack.cjs, assemble-pragent-runtime.mjs, the
pragent-shim Python subsystem (14 files), and .gitignore comments. Beyond
comments/docstrings, the developer-facing log/error OUTPUT strings in the
dev scripts are also translated (per the logs/exceptions-in-English
convention) — assemble-runtime logs, shim RuntimeError/_debug/_warn
messages, after-pack logs. Functional strings (LLM prompts, config keys,
sentinels, upstream-matched messages) left verbatim. Also fixes a stale
doc path in .gitignore (modules/04 → arch/02-agent/05).

Verified: node --check + py_compile + YAML parse all pass; prepare:pragent
re-synced the shim and the smoke test passes (shim patch active).

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@huhamhire huhamhire added the documentation Improvements or additions to documentation label Jul 5, 2026
@huhamhire
huhamhire merged commit 235872a into dev Jul 5, 2026
2 checks passed
@huhamhire
huhamhire deleted the docs/comments-tooling branch July 5, 2026 03:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant