mirror of
https://github.com/alibaba/open-code-review.git
synced 2026-10-02 01:15:23 +08:00
docs: tidy repo root and refresh screenshots; fix highlights label alignment (#1260)
* docs: refresh landing screenshots and add Korean Regenerate the highlights and benchmark images for en/ja/ru/zh and add the Korean (ko) variants now that the site ships a Korean locale. * docs: move localized README and CONTRIBUTING into docs/i18n/ The repo root listed five READMEs and five CONTRIBUTING files. Move the four translations of each into docs/i18n/ so only the English entry points remain in the root, and update every reference: the language switchers in the English files, the documentation-file table in CONTRIBUTING.md, the README sync rule in AGENTS.md, the README_FILES paths in the translation-sync checker, and the docs/i18n/** path trigger in the workflow. Relative links inside the moved files are rewritten to resolve from their new location. * chore: move SECURITY.md into .github/ GitHub still surfaces the Security policy when SECURITY.md lives under .github/, matching projects like kubernetes and vite. Update the two links in GOVERNANCE.md to the new path. * fix(pages): keep highlights stat labels aligned across locales Long stat labels wrapped to two lines on the fixed-width column, left-aligning the wrapped text and dropping that column's caption below the others. The label style now centers text and reserves two lines (lineHeight 16px, minHeight 32px) so every column's caption shares a baseline regardless of label length or locale. Also shorten highlights.stat2Label from 'NPM COMMUNITY DOWNLOADS' to 'NPM DOWNLOADS' across all five locales so it reads directly and fits one line, and regenerate the highlights screenshots to match. * docs: realign CONTRIBUTING documentation-file tables The docs/i18n/ path prefix widened the first column and knocked the table pipes out of alignment. Re-pad the columns (display-width aware, so the CJK and Cyrillic rows line up too). * docs: revert no-op benchmark screenshot re-renders Generating the Korean benchmark image re-rendered en/ja/ru too, producing byte-different but visually identical PNGs. Restore those three to their main versions; only benchmark-ko.png (the new Korean locale) is a real addition.
This commit is contained in:
Kite
@@ -10,6 +10,7 @@ on:
|
||||
pull_request:
|
||||
paths:
|
||||
- "README*.md"
|
||||
- "docs/i18n/**"
|
||||
- "pages/src/content/docs/**"
|
||||
- "scripts/github-actions/check-translation-sync.*"
|
||||
|
||||
|
||||
@@ -37,7 +37,7 @@ open-code-review (`ocr`) is an AI-powered code review CLI tool written in Go (mo
|
||||
|
||||
- After writing code, run `make check`. It formats and tidies in place, so there is no need to run `gofmt` or `go vet` separately.
|
||||
- **Source files are written in English** — comments, identifiers and strings alike. `make english-check` enforces this in CI. It flags any letter outside ASCII, whichever the writing system (Han, kana, Hangul, Cyrillic, and equally the diacritics that spell German or Vietnamese), plus combining accents and fullwidth punctuation (`：`, `（`), which is easy to leave behind in an otherwise English sentence. Symbols and emoji (`─ → ≥ ✅`) pass, since they are not letters. Prose spelled entirely in ASCII (`Loeschen der Datei`, or a romanised transcription) takes a dictionary to spot and stays a matter for review.
|
||||
- **Translated prose has its own homes, none of them scanned.** `README.<locale>.md` and `CONTRIBUTING.<locale>.md` (`zh-CN`, `ja-JP`, `ko-KR`, `ru-RU`); the doc pages under `pages/src/content/docs/<locale>/` (`en`, `zh`, `ja`, `ru`, Markdown throughout); and the UI copy tables in `pages/src/i18n/<locale>.ts`. Markdown is out of scope by extension, so translations go there freely. The i18n tables are `.ts` and would be scanned, so they are exempt by prefix instead — translated UI strings belong in those tables rather than inline in a component.
|
||||
- **Translated prose has its own homes, none of them scanned.** `docs/i18n/README.<locale>.md` and `docs/i18n/CONTRIBUTING.<locale>.md` (`zh-CN`, `ja-JP`, `ko-KR`, `ru-RU`); the doc pages under `pages/src/content/docs/<locale>/` (`en`, `zh`, `ja`, `ru`, Markdown throughout); and the UI copy tables in `pages/src/i18n/<locale>.ts`. Markdown is out of scope by extension, so translations go there freely. The i18n tables are `.ts` and would be scanned, so they are exempt by prefix instead — translated UI strings belong in those tables rather than inline in a component.
|
||||
- **Two escape hatches for the exceptional case, narrower one preferred.** Append an `allow-non-english: <reason>` marker comment to the offending line — the right choice for a handful of lines, such as an encoding fixture or a language-switcher label, and it leaves the rest of the file protected. Only for a whole tree that is inherently non-English, add a prefix to `allowedPrefixes` in `scripts/verify-english-only.go`; it currently holds just `pages/src/i18n/` and `extensions/vscode/`, the latter temporary until the extension's Chinese comments are translated.
|
||||
|
||||
## Testing
|
||||
@@ -49,7 +49,7 @@ open-code-review (`ocr`) is an AI-powered code review CLI tool written in Go (mo
|
||||
## README
|
||||
|
||||
- When modifying README.md, always sync the changes to all localized versions:
|
||||
- README.zh-CN.md
|
||||
- README.ja-JP.md
|
||||
- README.ko-KR.md
|
||||
- README.ru-RU.md
|
||||
- docs/i18n/README.zh-CN.md
|
||||
- docs/i18n/README.ja-JP.md
|
||||
- docs/i18n/README.ko-KR.md
|
||||
- docs/i18n/README.ru-RU.md
|
||||
|
||||
+14
-14
@@ -2,7 +2,7 @@
|
||||
|
||||
Thank you for your interest in contributing to OpenCodeReview! Every contribution matters — whether it's fixing a typo, reporting a bug, or implementing a new feature.
|
||||
|
||||
[简体中文版](CONTRIBUTING.zh-CN.md) | [日本語版](CONTRIBUTING.ja-JP.md) | [한국어](CONTRIBUTING.ko-KR.md) | [Русский](CONTRIBUTING.ru-RU.md)
|
||||
[简体中文版](docs/i18n/CONTRIBUTING.zh-CN.md) | [日本語版](docs/i18n/CONTRIBUTING.ja-JP.md) | [한국어](docs/i18n/CONTRIBUTING.ko-KR.md) | [Русский](docs/i18n/CONTRIBUTING.ru-RU.md)
|
||||
|
||||
## Code of Conduct
|
||||
|
||||
@@ -173,7 +173,7 @@ Documentation is a crucial part of OpenCodeReview. We welcome improvements to RE
|
||||
- Clarifying confusing explanations or adding missing context
|
||||
- Adding usage examples for commands or configuration options
|
||||
- Updating outdated content (e.g., after a feature change)
|
||||
- Translating or improving localized documentation (`README.zh-CN.md`, `README.ja-JP.md`, `README.ko-KR.md`, `README.ru-RU.md`, `CONTRIBUTING.zh-CN.md`, `CONTRIBUTING.ja-JP.md`, `CONTRIBUTING.ko-KR.md`, `CONTRIBUTING.ru-RU.md`)
|
||||
- Translating or improving localized documentation (`docs/i18n/README.zh-CN.md`, `docs/i18n/README.ja-JP.md`, `docs/i18n/README.ko-KR.md`, `docs/i18n/README.ru-RU.md`, `docs/i18n/CONTRIBUTING.zh-CN.md`, `docs/i18n/CONTRIBUTING.ja-JP.md`, `docs/i18n/CONTRIBUTING.ko-KR.md`, `docs/i18n/CONTRIBUTING.ru-RU.md`)
|
||||
|
||||
### Documentation Workflow
|
||||
|
||||
@@ -183,18 +183,18 @@ Documentation is a crucial part of OpenCodeReview. We welcome improvements to RE
|
||||
|
||||
### Documentation Files
|
||||
|
||||
| File | Purpose |
|
||||
| ----------------------- | ------------------------------------ |
|
||||
| `README.md` | Main project documentation (English) |
|
||||
| `README.zh-CN.md` | Chinese translation |
|
||||
| `README.ja-JP.md` | Japanese translation |
|
||||
| `README.ko-KR.md` | Korean translation |
|
||||
| `README.ru-RU.md` | Russian translation |
|
||||
| `CONTRIBUTING.md` | Contribution guide (English) |
|
||||
| `CONTRIBUTING.zh-CN.md` | Contribution guide (Chinese) |
|
||||
| `CONTRIBUTING.ja-JP.md` | Contribution guide (Japanese) |
|
||||
| `CONTRIBUTING.ko-KR.md` | Contribution guide (Korean) |
|
||||
| `CONTRIBUTING.ru-RU.md` | Contribution guide (Russian) |
|
||||
| File | Purpose |
|
||||
| --------------------------------- | ------------------------------------ |
|
||||
| `README.md` | Main project documentation (English) |
|
||||
| `docs/i18n/README.zh-CN.md` | Chinese translation |
|
||||
| `docs/i18n/README.ja-JP.md` | Japanese translation |
|
||||
| `docs/i18n/README.ko-KR.md` | Korean translation |
|
||||
| `docs/i18n/README.ru-RU.md` | Russian translation |
|
||||
| `CONTRIBUTING.md` | Contribution guide (English) |
|
||||
| `docs/i18n/CONTRIBUTING.zh-CN.md` | Contribution guide (Chinese) |
|
||||
| `docs/i18n/CONTRIBUTING.ja-JP.md` | Contribution guide (Japanese) |
|
||||
| `docs/i18n/CONTRIBUTING.ko-KR.md` | Contribution guide (Korean) |
|
||||
| `docs/i18n/CONTRIBUTING.ru-RU.md` | Contribution guide (Russian) |
|
||||
|
||||
## Submitting Changes
|
||||
|
||||
|
||||
+2
-2
@@ -60,7 +60,7 @@ Contributors are expected to follow:
|
||||
|
||||
- [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md)
|
||||
- [CONTRIBUTING.md](CONTRIBUTING.md)
|
||||
- [SECURITY.md](SECURITY.md) for vulnerability reporting
|
||||
- [SECURITY.md](.github/SECURITY.md) for vulnerability reporting
|
||||
|
||||
### Maintainers
|
||||
|
||||
@@ -160,7 +160,7 @@ The project's public collaboration channels are:
|
||||
- pull requests for concrete code and documentation review
|
||||
|
||||
Security issues should follow the private reporting guidance in
|
||||
[SECURITY.md](SECURITY.md).
|
||||
[SECURITY.md](.github/SECURITY.md).
|
||||
|
||||
## Continuity
|
||||
|
||||
|
||||
@@ -29,7 +29,7 @@
|
||||
<a href="#supported-agents"><img alt="Cursor" src="https://img.shields.io/badge/Cursor-supported-blueviolet.svg" /></a>
|
||||
</p>
|
||||
<p align="center">
|
||||
English | <a href="README.zh-CN.md">简体中文</a> | <a href="README.ja-JP.md">日本語</a> | <a href="README.ko-KR.md">한국어</a> | <a href="README.ru-RU.md">Русский</a>
|
||||
English | <a href="docs/i18n/README.zh-CN.md">简体中文</a> | <a href="docs/i18n/README.ja-JP.md">日本語</a> | <a href="docs/i18n/README.ko-KR.md">한국어</a> | <a href="docs/i18n/README.ru-RU.md">Русский</a>
|
||||
</p>
|
||||
|
||||
---
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
OpenCodeReviewへのコントリビューションに興味を持っていただきありがとうございます！タイポの修正、バグ報告、新機能の実装など、あらゆる貢献が重要です。
|
||||
|
||||
[English Version](CONTRIBUTING.md) | [简体中文版](CONTRIBUTING.zh-CN.md) | [한국어](CONTRIBUTING.ko-KR.md) | [Русский](CONTRIBUTING.ru-RU.md)
|
||||
[English Version](../../CONTRIBUTING.md) | [简体中文版](CONTRIBUTING.zh-CN.md) | [한국어](CONTRIBUTING.ko-KR.md) | [Русский](CONTRIBUTING.ru-RU.md)
|
||||
|
||||
## 行動規範
|
||||
|
||||
@@ -163,7 +163,7 @@ AI を開発に使った場合は、下記のルールに従ってください
|
||||
- 分かりにくい説明の明確化や不足しているコンテキストの追加
|
||||
- コマンドや設定オプションの使用例の追加
|
||||
- 古くなった内容の更新（機能変更後など）
|
||||
- 中国語ドキュメント（`README.zh-CN.md`、`CONTRIBUTING.zh-CN.md`）の翻訳や改善
|
||||
- 中国語ドキュメント（`docs/i18n/README.zh-CN.md`、`docs/i18n/CONTRIBUTING.zh-CN.md`）の翻訳や改善
|
||||
|
||||
### ドキュメントのワークフロー
|
||||
|
||||
@@ -173,12 +173,12 @@ AI を開発に使った場合は、下記のルールに従ってください
|
||||
|
||||
### ドキュメントファイル
|
||||
|
||||
| ファイル | 用途 |
|
||||
| ----------------------- | ------------------------------------ |
|
||||
| `README.md` | メインのプロジェクトドキュメント（英語） |
|
||||
| `README.zh-CN.md` | 中国語訳 |
|
||||
| `CONTRIBUTING.md` | コントリビューションガイド（英語） |
|
||||
| `CONTRIBUTING.zh-CN.md` | コントリビューションガイド（中国語） |
|
||||
| ファイル | 用途 |
|
||||
| --------------------------------- | ---------------------------------------- |
|
||||
| `README.md` | メインのプロジェクトドキュメント（英語） |
|
||||
| `docs/i18n/README.zh-CN.md` | 中国語訳 |
|
||||
| `CONTRIBUTING.md` | コントリビューションガイド（英語） |
|
||||
| `docs/i18n/CONTRIBUTING.zh-CN.md` | コントリビューションガイド（中国語） |
|
||||
|
||||
## 変更の提出
|
||||
|
||||
@@ -255,4 +255,4 @@ PR を素早くレビュー・マージしてもらいたいですか？以下
|
||||
|
||||
## ライセンス
|
||||
|
||||
OpenCodeReviewにコントリビューションすることで、あなたのコントリビューションが[Apache License 2.0](LICENSE)の下でライセンスされることに同意したことになります。
|
||||
OpenCodeReviewにコントリビューションすることで、あなたのコントリビューションが[Apache License 2.0](../../LICENSE)の下でライセンスされることに同意したことになります。
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
OpenCodeReview에 기여해 주셔서 감사합니다. 오타 수정, bug report, 새 기능 구현 등 모든 기여는 프로젝트에 도움이 됩니다.
|
||||
|
||||
[English](CONTRIBUTING.md) | [简体中文版](CONTRIBUTING.zh-CN.md) | [日本語版](CONTRIBUTING.ja-JP.md) | 한국어 | [Русский](CONTRIBUTING.ru-RU.md)
|
||||
[English](../../CONTRIBUTING.md) | [简体中文版](CONTRIBUTING.zh-CN.md) | [日本語版](CONTRIBUTING.ja-JP.md) | 한국어 | [Русский](CONTRIBUTING.ru-RU.md)
|
||||
|
||||
## Code of Conduct
|
||||
|
||||
@@ -164,7 +164,7 @@ AI가 개발 과정에 관여했다면 아래 규칙을 따라 주세요.
|
||||
- 혼란스러운 설명을 명확히 하거나 빠진 맥락 추가
|
||||
- command나 configuration option의 사용 예시 추가
|
||||
- feature 변경 이후 오래된 내용 update
|
||||
- 지역화 문서 번역 또는 개선(`README.zh-CN.md`, `README.ja-JP.md`, `README.ko-KR.md`, `CONTRIBUTING.zh-CN.md`, `CONTRIBUTING.ja-JP.md`, `CONTRIBUTING.ko-KR.md`)
|
||||
- 지역화 문서 번역 또는 개선(`docs/i18n/README.zh-CN.md`, `docs/i18n/README.ja-JP.md`, `docs/i18n/README.ko-KR.md`, `docs/i18n/CONTRIBUTING.zh-CN.md`, `docs/i18n/CONTRIBUTING.ja-JP.md`, `docs/i18n/CONTRIBUTING.ko-KR.md`)
|
||||
|
||||
### 문서 workflow
|
||||
|
||||
@@ -177,13 +177,13 @@ AI가 개발 과정에 관여했다면 아래 규칙을 따라 주세요.
|
||||
| File | Purpose |
|
||||
|------|---------|
|
||||
| `README.md` | main project documentation (English) |
|
||||
| `README.zh-CN.md` | Chinese translation |
|
||||
| `README.ja-JP.md` | Japanese translation |
|
||||
| `README.ko-KR.md` | Korean translation |
|
||||
| `docs/i18n/README.zh-CN.md` | Chinese translation |
|
||||
| `docs/i18n/README.ja-JP.md` | Japanese translation |
|
||||
| `docs/i18n/README.ko-KR.md` | Korean translation |
|
||||
| `CONTRIBUTING.md` | contribution guide (English) |
|
||||
| `CONTRIBUTING.zh-CN.md` | contribution guide (Chinese) |
|
||||
| `CONTRIBUTING.ja-JP.md` | contribution guide (Japanese) |
|
||||
| `CONTRIBUTING.ko-KR.md` | contribution guide (Korean) |
|
||||
| `docs/i18n/CONTRIBUTING.zh-CN.md` | contribution guide (Chinese) |
|
||||
| `docs/i18n/CONTRIBUTING.ja-JP.md` | contribution guide (Japanese) |
|
||||
| `docs/i18n/CONTRIBUTING.ko-KR.md` | contribution guide (Korean) |
|
||||
|
||||
## 변경 제출
|
||||
|
||||
@@ -260,4 +260,4 @@ PR이 빠르게 리뷰되고 merge되길 원하시나요? 다음 사항들이
|
||||
|
||||
## License
|
||||
|
||||
OpenCodeReview에 기여하면 해당 기여가 [Apache License 2.0](LICENSE)에 따라 license되는 것에 동의하는 것입니다.
|
||||
OpenCodeReview에 기여하면 해당 기여가 [Apache License 2.0](../../LICENSE)에 따라 license되는 것에 동의하는 것입니다.
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
Спасибо за интерес к развитию OpenCodeReview! Важен любой вклад — будь то исправленная опечатка, сообщение о баге или новая функциональность.
|
||||
|
||||
[English](CONTRIBUTING.md) | [简体中文版](CONTRIBUTING.zh-CN.md) | [日本語版](CONTRIBUTING.ja-JP.md) | [한국어](CONTRIBUTING.ko-KR.md) | Русский
|
||||
[English](../../CONTRIBUTING.md) | [简体中文版](CONTRIBUTING.zh-CN.md) | [日本語版](CONTRIBUTING.ja-JP.md) | [한국어](CONTRIBUTING.ko-KR.md) | Русский
|
||||
|
||||
## Кодекс поведения
|
||||
|
||||
@@ -163,7 +163,7 @@ make build
|
||||
- Прояснение запутанных объяснений и добавление недостающего контекста
|
||||
- Добавление примеров использования команд и параметров конфигурации
|
||||
- Обновление устаревшего содержимого (например, после изменения функциональности)
|
||||
- Перевод и улучшение локализованной документации (`README.zh-CN.md`, `README.ja-JP.md`, `README.ko-KR.md`, `README.ru-RU.md`, `CONTRIBUTING.zh-CN.md`, `CONTRIBUTING.ja-JP.md`, `CONTRIBUTING.ko-KR.md`, `CONTRIBUTING.ru-RU.md`)
|
||||
- Перевод и улучшение локализованной документации (`docs/i18n/README.zh-CN.md`, `docs/i18n/README.ja-JP.md`, `docs/i18n/README.ko-KR.md`, `docs/i18n/README.ru-RU.md`, `docs/i18n/CONTRIBUTING.zh-CN.md`, `docs/i18n/CONTRIBUTING.ja-JP.md`, `docs/i18n/CONTRIBUTING.ko-KR.md`, `docs/i18n/CONTRIBUTING.ru-RU.md`)
|
||||
|
||||
### Процесс работы с документацией
|
||||
|
||||
@@ -173,18 +173,18 @@ make build
|
||||
|
||||
### Файлы документации
|
||||
|
||||
| Файл | Назначение |
|
||||
| ----------------------- | ------------------------------------------- |
|
||||
| `README.md` | Основная документация проекта (английский) |
|
||||
| `README.zh-CN.md` | Китайский перевод |
|
||||
| `README.ja-JP.md` | Японский перевод |
|
||||
| `README.ko-KR.md` | Корейский перевод |
|
||||
| `README.ru-RU.md` | Русский перевод |
|
||||
| `CONTRIBUTING.md` | Руководство контрибьютора (английский) |
|
||||
| `CONTRIBUTING.zh-CN.md` | Руководство контрибьютора (китайский) |
|
||||
| `CONTRIBUTING.ja-JP.md` | Руководство контрибьютора (японский) |
|
||||
| `CONTRIBUTING.ko-KR.md` | Руководство контрибьютора (корейский) |
|
||||
| `CONTRIBUTING.ru-RU.md` | Руководство контрибьютора (русский) |
|
||||
| Файл | Назначение |
|
||||
| --------------------------------- | ------------------------------------------ |
|
||||
| `README.md` | Основная документация проекта (английский) |
|
||||
| `docs/i18n/README.zh-CN.md` | Китайский перевод |
|
||||
| `docs/i18n/README.ja-JP.md` | Японский перевод |
|
||||
| `docs/i18n/README.ko-KR.md` | Корейский перевод |
|
||||
| `docs/i18n/README.ru-RU.md` | Русский перевод |
|
||||
| `CONTRIBUTING.md` | Руководство контрибьютора (английский) |
|
||||
| `docs/i18n/CONTRIBUTING.zh-CN.md` | Руководство контрибьютора (китайский) |
|
||||
| `docs/i18n/CONTRIBUTING.ja-JP.md` | Руководство контрибьютора (японский) |
|
||||
| `docs/i18n/CONTRIBUTING.ko-KR.md` | Руководство контрибьютора (корейский) |
|
||||
| `docs/i18n/CONTRIBUTING.ru-RU.md` | Руководство контрибьютора (русский) |
|
||||
|
||||
## Отправка изменений
|
||||
|
||||
@@ -261,4 +261,4 @@ feat(agent): add support for custom tool definitions
|
||||
|
||||
## Лицензия
|
||||
|
||||
Внося вклад в OpenCodeReview, вы соглашаетесь с тем, что ваш вклад будет лицензирован на условиях [Apache License 2.0](LICENSE).
|
||||
Внося вклад в OpenCodeReview, вы соглашаетесь с тем, что ваш вклад будет лицензирован на условиях [Apache License 2.0](../../LICENSE).
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
感谢你对 OpenCodeReview 的关注！无论是修复拼写错误、报告 Bug，还是实现新功能，每一份贡献都很有价值。
|
||||
|
||||
[English version](CONTRIBUTING.md) | [日本語版](CONTRIBUTING.ja-JP.md) | [한국어](CONTRIBUTING.ko-KR.md) | [Русский](CONTRIBUTING.ru-RU.md)
|
||||
[English version](../../CONTRIBUTING.md) | [日本語版](CONTRIBUTING.ja-JP.md) | [한국어](CONTRIBUTING.ko-KR.md) | [Русский](CONTRIBUTING.ru-RU.md)
|
||||
|
||||
## 行为准则
|
||||
|
||||
@@ -163,7 +163,7 @@ make build
|
||||
- 完善表述不清的说明或补充缺失的上下文
|
||||
- 为命令或配置项添加使用示例
|
||||
- 更新过时的内容（例如功能变更后的文档同步）
|
||||
- 翻译或改进中英文文档（`README.zh-CN.md`、`CONTRIBUTING.zh-CN.md`）
|
||||
- 翻译或改进中英文文档（`docs/i18n/README.zh-CN.md`、`docs/i18n/CONTRIBUTING.zh-CN.md`）
|
||||
|
||||
### 文档贡献流程
|
||||
|
||||
@@ -173,12 +173,12 @@ make build
|
||||
|
||||
### 文档文件一览
|
||||
|
||||
| 文件 | 用途 |
|
||||
| ----------------------- | -------------------- |
|
||||
| `README.md` | 项目主文档（英文） |
|
||||
| `README.zh-CN.md` | 中文翻译 |
|
||||
| `CONTRIBUTING.md` | 贡献指南（英文） |
|
||||
| `CONTRIBUTING.zh-CN.md` | 贡献指南（中文） |
|
||||
| 文件 | 用途 |
|
||||
| --------------------------------- | ------------------ |
|
||||
| `README.md` | 项目主文档（英文） |
|
||||
| `docs/i18n/README.zh-CN.md` | 中文翻译 |
|
||||
| `CONTRIBUTING.md` | 贡献指南（英文） |
|
||||
| `docs/i18n/CONTRIBUTING.zh-CN.md` | 贡献指南（中文） |
|
||||
|
||||
## 提交变更
|
||||
|
||||
@@ -255,4 +255,4 @@ feat(agent): add support for custom tool definitions
|
||||
|
||||
## 许可证
|
||||
|
||||
向 OpenCodeReview 贡献代码即表示你同意你的贡献将以 [Apache License 2.0](LICENSE) 进行许可。
|
||||
向 OpenCodeReview 贡献代码即表示你同意你的贡献将以 [Apache License 2.0](../../LICENSE) 进行许可。
|
||||
@@ -1,6 +1,6 @@
|
||||
<div align="center">
|
||||
<a href="https://open-codereview.ai">
|
||||
<img src="imgs/logo-core.svg" alt="OpenCodeReview logo" width="180" />
|
||||
<img src="../../imgs/logo-core.svg" alt="OpenCodeReview logo" width="180" />
|
||||
</a>
|
||||
<h1>OpenCodeReview</h1>
|
||||
</div>
|
||||
@@ -29,7 +29,7 @@
|
||||
<a href="#supported-agents"><img alt="Cursor" src="https://img.shields.io/badge/Cursor-supported-blueviolet.svg" /></a>
|
||||
</p>
|
||||
<p align="center">
|
||||
<a href="README.md">English</a> | <a href="README.zh-CN.md">简体中文</a> | 日本語 | <a href="README.ko-KR.md">한국어</a> | <a href="README.ru-RU.md">Русский</a>
|
||||
<a href="../../README.md">English</a> | <a href="README.zh-CN.md">简体中文</a> | 日本語 | <a href="README.ko-KR.md">한국어</a> | <a href="README.ru-RU.md">Русский</a>
|
||||
</p>
|
||||
|
||||
---
|
||||
@@ -42,7 +42,7 @@ Gitのdiffを読み取り、変更されたファイルをツール利用機能
|
||||
|
||||
詳細は[公式サイト](https://open-codereview.ai)をご覧ください。
|
||||
|
||||
|
||||
|
||||
|
||||
## ベンチマーク
|
||||
|
||||
@@ -60,7 +60,7 @@ Gitのdiffを読み取り、変更されたファイルをツール利用機能
|
||||
| **平均時間 (Avg Time)** | レビューあたりの実時間 | CIパイプラインの待機時間に影響 |
|
||||
| **平均トークン (Avg Token)** | レビューあたりの総トークン消費量 | APIコストに直接影響 |
|
||||
|
||||
|
||||
|
||||
|
||||
## なぜOpen Code Reviewなのか？
|
||||
|
||||
@@ -123,7 +123,7 @@ ocr config provider # ビルトインプロバイダーを選択また
|
||||
ocr config model # アクティブなプロバイダーのモデルを選択
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
対話的UIがプロバイダーの選択、APIキーの入力、モデル設定をガイドし、完了後に自動的に接続テストを行います。
|
||||
|
||||
@@ -172,11 +172,11 @@ ocr delegate rule src/main.go src/handler.go
|
||||
- [設定](https://open-codereview.ai/docs/configuration) — 設定キーと環境変数
|
||||
- [MCP サーバー](https://open-codereview.ai/docs/mcp) — 外部ツールでレビューエージェントを拡張
|
||||
- コーディングエージェント連携 — 使用するプラットフォームを選択
|
||||
- [Claude Code](plugins/open-code-review/README.md#claude-code) — レビュー用スラッシュコマンドを含むプラグインをインストール
|
||||
- [Codex](plugins/open-code-review/README.md#codex) — 呼び出し可能なレビュースキルを含むプラグインをインストール
|
||||
- [Cursor](plugins/open-code-review/README.md#cursor) — 移植可能なレビュースキルを含むプラグインをインストール
|
||||
- [OpenCode](plugins/open-code-review/opencode/README.md) — ネイティブレビュー・ツールとスラッシュコマンドをインストール
|
||||
- [QCA Forward](plugins/open-code-review/qca/README.md) — QCA ホストモデルと公開可能なテンプレートで委任モードを実行
|
||||
- [Claude Code](../../plugins/open-code-review/README.md#claude-code) — レビュー用スラッシュコマンドを含むプラグインをインストール
|
||||
- [Codex](../../plugins/open-code-review/README.md#codex) — 呼び出し可能なレビュースキルを含むプラグインをインストール
|
||||
- [Cursor](../../plugins/open-code-review/README.md#cursor) — 移植可能なレビュースキルを含むプラグインをインストール
|
||||
- [OpenCode](../../plugins/open-code-review/opencode/README.md) — ネイティブレビュー・ツールとスラッシュコマンドをインストール
|
||||
- [QCA Forward](../../plugins/open-code-review/qca/README.md) — QCA ホストモデルと公開可能なテンプレートで委任モードを実行
|
||||
- [Skill 対応エージェント](https://open-codereview.ai/docs/agent-skill) — 移植可能なエージェントスキルをインストール
|
||||
- レビュー実行モード — 連携後、どの LLM がレビューを実行するかを選択
|
||||
- [デフォルト（OCR が管理）](https://open-codereview.ai/docs/configuration) — OCR が設定済みの LLM を使用してレビューを実行
|
||||
@@ -196,4 +196,4 @@ ocr delegate rule src/main.go src/handler.go
|
||||
|
||||
## ライセンス
|
||||
|
||||
[Apache-2.0](LICENSE) — Copyright 2026 Alibaba
|
||||
[Apache-2.0](../../LICENSE) — Copyright 2026 Alibaba
|
||||
@@ -1,6 +1,6 @@
|
||||
<div align="center">
|
||||
<a href="https://open-codereview.ai">
|
||||
<img src="imgs/logo-core.svg" alt="OpenCodeReview logo" width="180" />
|
||||
<img src="../../imgs/logo-core.svg" alt="OpenCodeReview logo" width="180" />
|
||||
</a>
|
||||
<h1>OpenCodeReview</h1>
|
||||
</div>
|
||||
@@ -29,7 +29,7 @@
|
||||
<a href="#supported-agents"><img alt="Cursor" src="https://img.shields.io/badge/Cursor-supported-blueviolet.svg" /></a>
|
||||
</p>
|
||||
<p align="center">
|
||||
<a href="README.md">English</a> | <a href="README.zh-CN.md">简体中文</a> | <a href="README.ja-JP.md">日本語</a> | 한국어 | <a href="README.ru-RU.md">Русский</a>
|
||||
<a href="../../README.md">English</a> | <a href="README.zh-CN.md">简体中文</a> | <a href="README.ja-JP.md">日本語</a> | 한국어 | <a href="README.ru-RU.md">Русский</a>
|
||||
</p>
|
||||
|
||||
---
|
||||
@@ -42,7 +42,7 @@ Open Code Review는 AI 기반 코드 리뷰 CLI 도구입니다. Alibaba Group
|
||||
|
||||
자세한 내용은 [공식 웹사이트](https://open-codereview.ai)를 참조하세요.
|
||||
|
||||
|
||||
|
||||
|
||||
## 벤치마크
|
||||
|
||||
@@ -60,7 +60,7 @@ Open Code Review는 AI 기반 코드 리뷰 CLI 도구입니다. Alibaba Group
|
||||
| **평균 시간 (Avg Time)** | 리뷰당 실제 소요 시간 | CI 파이프라인 대기 시간에 영향 |
|
||||
| **평균 토큰 (Avg Token)** | 리뷰당 총 토큰 소비량 | API 비용에 직접 영향 |
|
||||
|
||||
|
||||
|
||||
|
||||
## 왜 Open Code Review인가?
|
||||
|
||||
@@ -123,7 +123,7 @@ ocr config provider # built-in provider 선택 또는 custom provider
|
||||
ocr config model # 활성 provider의 model 선택
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
대화형 UI가 provider 선택, API key 입력, model 설정을 안내하며, 완료 후 자동으로 연결 테스트를 수행합니다.
|
||||
|
||||
@@ -172,11 +172,11 @@ ocr delegate rule src/main.go src/handler.go
|
||||
- [설정](https://open-codereview.ai/docs/configuration) — 설정 키와 환경 변수
|
||||
- [MCP 서버](https://open-codereview.ai/docs/mcp) — 외부 도구로 리뷰 에이전트 확장
|
||||
- 코딩 에이전트 연동 — 사용하는 플랫폼 선택
|
||||
- [Claude Code](plugins/open-code-review/README.md#claude-code) — 리뷰 슬래시 명령이 포함된 플러그인 설치
|
||||
- [Codex](plugins/open-code-review/README.md#codex) — 호출 가능한 리뷰 스킬이 포함된 플러그인 설치
|
||||
- [Cursor](plugins/open-code-review/README.md#cursor) — 이식 가능한 리뷰 스킬이 포함된 플러그인 설치
|
||||
- [OpenCode](plugins/open-code-review/opencode/README.md) — 네이티브 리뷰 도구와 슬래시 명령 설치
|
||||
- [QCA Forward](plugins/open-code-review/qca/README.md) — QCA 호스트 모델과 게시 가능한 템플릿으로 위임 모드 실행
|
||||
- [Claude Code](../../plugins/open-code-review/README.md#claude-code) — 리뷰 슬래시 명령이 포함된 플러그인 설치
|
||||
- [Codex](../../plugins/open-code-review/README.md#codex) — 호출 가능한 리뷰 스킬이 포함된 플러그인 설치
|
||||
- [Cursor](../../plugins/open-code-review/README.md#cursor) — 이식 가능한 리뷰 스킬이 포함된 플러그인 설치
|
||||
- [OpenCode](../../plugins/open-code-review/opencode/README.md) — 네이티브 리뷰 도구와 슬래시 명령 설치
|
||||
- [QCA Forward](../../plugins/open-code-review/qca/README.md) — QCA 호스트 모델과 게시 가능한 템플릿으로 위임 모드 실행
|
||||
- [Skill 호환 에이전트](https://open-codereview.ai/docs/agent-skill) — 이식 가능한 에이전트 스킬 설치
|
||||
- 리뷰 실행 모드 — 연동 후 리뷰를 수행할 LLM 선택
|
||||
- [기본 모드(OCR 관리)](https://open-codereview.ai/docs/configuration) — OCR이 설정된 LLM을 사용해 리뷰 수행
|
||||
@@ -196,4 +196,4 @@ ocr delegate rule src/main.go src/handler.go
|
||||
|
||||
## License
|
||||
|
||||
[Apache-2.0](LICENSE) Copyright 2026 Alibaba
|
||||
[Apache-2.0](../../LICENSE) Copyright 2026 Alibaba
|
||||
@@ -1,6 +1,6 @@
|
||||
<div align="center">
|
||||
<a href="https://open-codereview.ai">
|
||||
<img src="imgs/logo-core.svg" alt="OpenCodeReview logo" width="180" />
|
||||
<img src="../../imgs/logo-core.svg" alt="OpenCodeReview logo" width="180" />
|
||||
</a>
|
||||
<h1>OpenCodeReview</h1>
|
||||
</div>
|
||||
@@ -29,7 +29,7 @@
|
||||
<a href="#supported-agents"><img alt="Cursor" src="https://img.shields.io/badge/Cursor-supported-blueviolet.svg" /></a>
|
||||
</p>
|
||||
<p align="center">
|
||||
<a href="README.md">English</a> | <a href="README.zh-CN.md">简体中文</a> | <a href="README.ja-JP.md">日本語</a> | <a href="README.ko-KR.md">한국어</a> | Русский
|
||||
<a href="../../README.md">English</a> | <a href="README.zh-CN.md">简体中文</a> | <a href="README.ja-JP.md">日本語</a> | <a href="README.ko-KR.md">한국어</a> | Русский
|
||||
</p>
|
||||
|
||||
---
|
||||
@@ -42,7 +42,7 @@ Open Code Review — это CLI-инструмент для код-ревью н
|
||||
|
||||
Подробнее на [официальном сайте](https://open-codereview.ai).
|
||||
|
||||
|
||||
|
||||
|
||||
## Бенчмарк
|
||||
|
||||
@@ -60,7 +60,7 @@ Open Code Review — это CLI-инструмент для код-ревью н
|
||||
| **Avg Time** | Время выполнения одного ревью | Влияет на задержки в CI-пайплайне |
|
||||
| **Avg Token** | Суммарное потребление токенов за ревью | Прямо влияет на стоимость API |
|
||||
|
||||
|
||||
|
||||
|
||||
## Почему Open Code Review?
|
||||
|
||||
@@ -123,7 +123,7 @@ ocr config provider # Выбрать встроенного прова
|
||||
ocr config model # Выбрать модель для активного провайдера
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
Интерактивный UI проведёт вас через выбор провайдера, ввод API-ключа и настройку модели, после чего автоматически проверит подключение.
|
||||
|
||||
@@ -172,11 +172,11 @@ ocr delegate rule src/main.go src/handler.go
|
||||
- [Конфигурация](https://open-codereview.ai/docs/configuration) — ключи конфигурации и переменные окружения
|
||||
- [MCP-сервер](https://open-codereview.ai/docs/mcp) — расширение агента ревью внешними инструментами
|
||||
- Интеграции с кодинг-агентами — выберите используемую платформу
|
||||
- [Claude Code](plugins/open-code-review/README.md#claude-code) — установка плагина со slash-командами для ревью
|
||||
- [Codex](plugins/open-code-review/README.md#codex) — установка плагина с вызываемыми навыками ревью
|
||||
- [Cursor](plugins/open-code-review/README.md#cursor) — установка плагина с переносимыми навыками ревью
|
||||
- [OpenCode](plugins/open-code-review/opencode/README.md) — установка нативных инструментов ревью и slash-команд
|
||||
- [QCA Forward](plugins/open-code-review/qca/README.md) — запуск режима делегирования с хост-моделью QCA и готовым к публикации шаблоном
|
||||
- [Claude Code](../../plugins/open-code-review/README.md#claude-code) — установка плагина со slash-командами для ревью
|
||||
- [Codex](../../plugins/open-code-review/README.md#codex) — установка плагина с вызываемыми навыками ревью
|
||||
- [Cursor](../../plugins/open-code-review/README.md#cursor) — установка плагина с переносимыми навыками ревью
|
||||
- [OpenCode](../../plugins/open-code-review/opencode/README.md) — установка нативных инструментов ревью и slash-команд
|
||||
- [QCA Forward](../../plugins/open-code-review/qca/README.md) — запуск режима делегирования с хост-моделью QCA и готовым к публикации шаблоном
|
||||
- [Агенты с поддержкой Skill](https://open-codereview.ai/docs/agent-skill) — установка переносимого навыка агента
|
||||
- Режимы выполнения ревью — после интеграции выберите, какая LLM выполняет ревью
|
||||
- [По умолчанию (под управлением OCR)](https://open-codereview.ai/docs/configuration) — OCR выполняет ревью с помощью настроенной LLM
|
||||
@@ -196,4 +196,4 @@ ocr delegate rule src/main.go src/handler.go
|
||||
|
||||
## Лицензия
|
||||
|
||||
[Apache-2.0](LICENSE) — Copyright 2026 Alibaba
|
||||
[Apache-2.0](../../LICENSE) — Copyright 2026 Alibaba
|
||||
@@ -1,6 +1,6 @@
|
||||
<div align="center">
|
||||
<a href="https://open-codereview.ai">
|
||||
<img src="imgs/logo-core.svg" alt="OpenCodeReview logo" width="180" />
|
||||
<img src="../../imgs/logo-core.svg" alt="OpenCodeReview logo" width="180" />
|
||||
</a>
|
||||
<h1>OpenCodeReview</h1>
|
||||
</div>
|
||||
@@ -29,7 +29,7 @@
|
||||
<a href="#supported-agents"><img alt="Cursor" src="https://img.shields.io/badge/Cursor-supported-blueviolet.svg" /></a>
|
||||
</p>
|
||||
<p align="center">
|
||||
<a href="README.md">English</a> | 简体中文 | <a href="README.ja-JP.md">日本語</a> | <a href="README.ko-KR.md">한국어</a> | <a href="README.ru-RU.md">Русский</a>
|
||||
<a href="../../README.md">English</a> | 简体中文 | <a href="README.ja-JP.md">日本語</a> | <a href="README.ko-KR.md">한국어</a> | <a href="README.ru-RU.md">Русский</a>
|
||||
</p>
|
||||
|
||||
---
|
||||
@@ -42,7 +42,7 @@ Open Code Review 是一款 AI 驱动的代码审查 CLI 工具。它的前身是
|
||||
|
||||
访问[官方网站](https://open-codereview.ai)了解更多信息。
|
||||
|
||||
|
||||
|
||||
|
||||
## 基准测试
|
||||
|
||||
@@ -60,7 +60,7 @@ Open Code Review 是一款 AI 驱动的代码审查 CLI 工具。它的前身是
|
||||
| **平均耗时 (Avg Time)** | 每次审查的实际耗时 | 决定 CI 流水线的等待时间 |
|
||||
| **平均 Token (Avg Token)** | 每次审查消耗的总 token 数 | 直接影响 API 使用成本 |
|
||||
|
||||
|
||||
|
||||
|
||||
## 为什么选择 Open Code Review？
|
||||
|
||||
@@ -123,7 +123,7 @@ ocr config provider # 选择内置供应商或添加自定义供应商
|
||||
ocr config model # 为当前供应商选择模型
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
交互式界面会引导你完成供应商选择、API Key 输入和模型配置，完成后自动测试连通性。
|
||||
|
||||
@@ -172,11 +172,11 @@ ocr delegate rule src/main.go src/handler.go
|
||||
- [配置](https://open-codereview.ai/docs/configuration) —— 配置项与环境变量
|
||||
- [MCP 服务器](https://open-codereview.ai/docs/mcp) —— 用外部工具扩展评审 agent
|
||||
- 编程 Agent 集成 —— 选择你使用的平台
|
||||
- [Claude Code](plugins/open-code-review/README.md#claude-code) —— 安装包含评审斜杠命令的插件
|
||||
- [Codex](plugins/open-code-review/README.md#codex) —— 安装包含可调用评审 Skill 的插件
|
||||
- [Cursor](plugins/open-code-review/README.md#cursor) —— 安装包含可移植评审 Skill 的插件
|
||||
- [OpenCode](plugins/open-code-review/opencode/README.md) —— 安装原生评审工具和斜杠命令
|
||||
- [QCA Forward](plugins/open-code-review/qca/README.md) —— 使用 QCA 宿主模型运行委托模式，并提供可发布的模板
|
||||
- [Claude Code](../../plugins/open-code-review/README.md#claude-code) —— 安装包含评审斜杠命令的插件
|
||||
- [Codex](../../plugins/open-code-review/README.md#codex) —— 安装包含可调用评审 Skill 的插件
|
||||
- [Cursor](../../plugins/open-code-review/README.md#cursor) —— 安装包含可移植评审 Skill 的插件
|
||||
- [OpenCode](../../plugins/open-code-review/opencode/README.md) —— 安装原生评审工具和斜杠命令
|
||||
- [QCA Forward](../../plugins/open-code-review/qca/README.md) —— 使用 QCA 宿主模型运行委托模式，并提供可发布的模板
|
||||
- [兼容 Skill 的 Agent](https://open-codereview.ai/docs/agent-skill) —— 安装可移植的 Agent Skill
|
||||
- 评审执行模式 —— 完成集成后，选择由哪个 LLM 执行评审
|
||||
- [默认模式（OCR 驱动）](https://open-codereview.ai/docs/configuration) —— OCR 使用其已配置的 LLM 执行评审
|
||||
@@ -196,4 +196,4 @@ ocr delegate rule src/main.go src/handler.go
|
||||
|
||||
## 许可证
|
||||
|
||||
[Apache-2.0](LICENSE) — Copyright 2026 Alibaba
|
||||
[Apache-2.0](../../LICENSE) — Copyright 2026 Alibaba
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 407 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 48 KiB After Width: | Height: | Size: 53 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 52 KiB After Width: | Height: | Size: 57 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 52 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 51 KiB After Width: | Height: | Size: 59 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 53 KiB After Width: | Height: | Size: 57 KiB |
@@ -159,6 +159,11 @@ const HighlightsSection: React.FC = () => {
|
||||
fontWeight: 500,
|
||||
letterSpacing: '0.5px',
|
||||
textTransform: 'uppercase',
|
||||
textAlign: 'center',
|
||||
lineHeight: '16px',
|
||||
// Reserve two lines so a label that wraps (long locales such
|
||||
// as en/ru) keeps every column's caption on the same baseline.
|
||||
minHeight: 32,
|
||||
margin: 0,
|
||||
}}
|
||||
>
|
||||
|
||||
@@ -41,7 +41,7 @@ export const en = {
|
||||
'highlights.stat1Label': 'INTERNAL ACTIVE USERS',
|
||||
'highlights.stat1Caption': 'Battle-tested inside Alibaba Group',
|
||||
'highlights.stat2Value': '150K+',
|
||||
'highlights.stat2Label': 'NPM COMMUNITY DOWNLOADS',
|
||||
'highlights.stat2Label': 'NPM DOWNLOADS',
|
||||
'highlights.stat2Caption': 'Real npm downloads · last 30 days',
|
||||
'highlights.stat3Value': '3M+',
|
||||
'highlights.stat3Label': 'REAL-WORLD TASKS',
|
||||
|
||||
@@ -43,7 +43,7 @@ export const ja: TranslationKeys = {
|
||||
'highlights.stat1Label': '社内アクティブユーザー',
|
||||
'highlights.stat1Caption': 'Alibabaグループ内で実戦検証済み',
|
||||
'highlights.stat2Value': '150K+',
|
||||
'highlights.stat2Label': 'NPM コミュニティダウンロード',
|
||||
'highlights.stat2Label': 'NPM ダウンロード',
|
||||
'highlights.stat2Caption': 'npm 過去30日の実ダウンロード数',
|
||||
'highlights.stat3Value': '3M+',
|
||||
'highlights.stat3Label': '実タスク',
|
||||
|
||||
@@ -43,7 +43,7 @@ export const ko: TranslationKeys = {
|
||||
'highlights.stat1Label': '사내 활성 사용자',
|
||||
'highlights.stat1Caption': 'Alibaba 그룹 내부에서 실전 검증',
|
||||
'highlights.stat2Value': '150K+',
|
||||
'highlights.stat2Label': 'NPM 커뮤니티 다운로드',
|
||||
'highlights.stat2Label': 'NPM 다운로드',
|
||||
'highlights.stat2Caption': '실제 npm 다운로드 수 · 최근 30일',
|
||||
'highlights.stat3Value': '3M+',
|
||||
'highlights.stat3Label': '실제 작업',
|
||||
|
||||
@@ -43,7 +43,7 @@ export const ru: TranslationKeys = {
|
||||
'highlights.stat1Label': 'ВНУТРЕННИЕ АКТИВНЫЕ ПОЛЬЗОВАТЕЛИ',
|
||||
'highlights.stat1Caption': 'в Alibaba Group',
|
||||
'highlights.stat2Value': '150K+',
|
||||
'highlights.stat2Label': 'ЗАГРУЗКИ СООБЩЕСТВА NPM',
|
||||
'highlights.stat2Label': 'ЗАГРУЗКИ NPM',
|
||||
'highlights.stat2Caption': 'реальные загрузки npm · 30 дней',
|
||||
'highlights.stat3Value': '3M+',
|
||||
'highlights.stat3Label': 'РЕАЛЬНЫХ ЗАДАЧ',
|
||||
|
||||
@@ -43,7 +43,7 @@ export const zh: TranslationKeys = {
|
||||
'highlights.stat1Label': '内部活跃用户',
|
||||
'highlights.stat1Caption': '经阿里巴巴集团内部实战验证',
|
||||
'highlights.stat2Value': '150K+',
|
||||
'highlights.stat2Label': 'NPM 社区下载量',
|
||||
'highlights.stat2Label': 'NPM 下载量',
|
||||
'highlights.stat2Caption': 'npm 近 30 天真实下载',
|
||||
'highlights.stat3Value': '3M+',
|
||||
'highlights.stat3Label': '真实任务',
|
||||
|
||||
@@ -34,13 +34,15 @@ const path = require("path");
|
||||
const { execFileSync } = require("child_process");
|
||||
|
||||
// The five localized README files. README.md (English) is the reference every
|
||||
// translation is compared against. Discovered names confirmed in the repo root.
|
||||
// translation is compared against. The English entry point stays in the repo
|
||||
// root; the four translations live under docs/i18n/ to keep the root listing
|
||||
// small (paths are relative to the repo root, joined with repoRoot below).
|
||||
const README_FILES = [
|
||||
"README.md",
|
||||
"README.zh-CN.md",
|
||||
"README.ja-JP.md",
|
||||
"README.ko-KR.md",
|
||||
"README.ru-RU.md",
|
||||
"docs/i18n/README.zh-CN.md",
|
||||
"docs/i18n/README.ja-JP.md",
|
||||
"docs/i18n/README.ko-KR.md",
|
||||
"docs/i18n/README.ru-RU.md",
|
||||
];
|
||||
|
||||
// Docs live under pages/src/content/docs/<locale>/**. English is authored under
|
||||
|
||||
@@ -9,8 +9,8 @@
|
||||
// Comments, identifiers and user-visible strings in this repository are written
|
||||
// in English so that any contributor can review and maintain every file,
|
||||
// whichever languages they happen to read. Translated content belongs in the
|
||||
// locale-specific docs (README.zh-CN.md, pages/src/content/docs/zh/…) and in
|
||||
// the i18n tables, not in code.
|
||||
// locale-specific docs (docs/i18n/README.zh-CN.md, pages/src/content/docs/zh/…)
|
||||
// and in the i18n tables, not in code.
|
||||
//
|
||||
// What it detects, and the one thing it cannot:
|
||||
//
|
||||
@@ -246,7 +246,7 @@ func run() error {
|
||||
}
|
||||
fmt.Fprintf(os.Stderr, `
|
||||
Source files are English-only: comments, identifiers and strings alike.
|
||||
Translated prose belongs in README.<locale>.md, pages/src/content/docs/<locale>/
|
||||
Translated prose belongs in docs/i18n/README.<locale>.md, pages/src/content/docs/<locale>/
|
||||
or an i18n table.
|
||||
|
||||
If the non-English text is intentional — an encoding fixture, a
|
||||
|
||||
Reference in New Issue
Block a user