Skip to content

docs(i18n): add Polish localization scout - #3121

Open
Dante-dan wants to merge 2 commits into
affaan-m:mainfrom
Dante-dan:feat/3096-polish-scout
Open

docs(i18n): add Polish localization scout#3121
Dante-dan wants to merge 2 commits into
affaan-m:mainfrom
Dante-dan:feat/3096-polish-scout

Conversation

@Dante-dan

Copy link
Copy Markdown
Contributor

What Changed

  • Added a bounded Polish scout under docs/pl/: a Polish getting-started and core-concepts guide plus a terminology glossary.
  • Registered docs-pl and locale:pl, with both pl and pl-PL installer aliases, and included the locale in the npm publish surface.
  • Added Polish to the language navigation in the root and existing localized READMEs.
  • Extended the existing locale-install contract checks for Polish module resolution and the regional alias.

The Polish guide records English source commit 8321021c and its exact translated scope. It links the complete English README rather than presenting this first increment as a full translation.

Why This Change

This implements the scout proposed by @majevva in #3096 and follows their correction to use the short pl directory code. It also follows the owner guidance and merged German precedent in #1980/#2029: keep new locale docs under docs/<locale>/, establish terminology, make the locale discoverable, and register installer support in the same bounded PR.

The initial guide deliberately focuses on setup, the major ECC surfaces, safety, and the translation workflow. Further translation can continue incrementally by domain without creating another large overlapping localization PR.

Refs #3096

Testing Done

  • Manual testing completed
  • Automated tests pass locally (node tests/run-all.js)
  • Edge cases considered and tested

Focused repository checks completed:

  • node tests/lib/locale-install.test.js — 12 passed, 0 failed
  • node tests/lib/install-manifests.test.js — 41 passed, 0 failed
  • node scripts/ci/validate-install-manifests.js — validated 38 modules, 85 components, and 7 profiles
  • node tests/scripts/npm-publish-surface.test.js — 2 passed, 0 failed
  • markdownlint 'docs/pl/**/*.md' — clean
  • git diff --check — clean

The aggregate npm test was not run because this documentation/manifest slice was covered by the focused checks above and the repository aggregate currently includes local UI/E2E paths outside this run's allowed validation scope.

Type of Change

  • fix: Bug fix
  • feat: New feature
  • refactor: Code refactoring
  • docs: Documentation
  • test: Tests
  • chore: Maintenance/tooling
  • ci: CI/CD changes

Security & Quality Checklist

  • No secrets or API keys committed (ghp_, sk-, AKIA, xoxb, xoxp patterns checked)
  • JSON files validate cleanly
  • Shell scripts pass shellcheck (if applicable) — no shell changes
  • Pre-commit hooks pass locally (if configured) — not run
  • No sensitive data exposed in logs or output
  • Follows conventional commits format

If you changed dependencies or package.json (bin / files / deps)

  • Ran yarn install --mode=update-lockfile; yarn.lock remained unchanged.

If you added a skill, command, agent, hook, or CLI tool

Not applicable; this adds a documentation locale and installer manifest entries.

Documentation

  • Updated relevant documentation
  • Added comments for complex logic — no complex logic added
  • README updated (if needed)

Signed-off-by: Dante <duanjl.china@gmail.com>
@Dante-dan
Dante-dan requested a review from affaan-m as a code owner September 14, 2026 08:11
@ecc-tools

ecc-tools Bot commented Sep 14, 2026

Copy link
Copy Markdown
Contributor

ECC Tools / Security Evidence

Commit: 3e72db8aa524db797024b2931fc9c577616d6c92

Security evidence gate passed (success)

No security-sensitive scanner-evidence gap detected.

Mode: enforce

Scanned 22 changed file(s). No missing scanner-evidence signal was detected.

Check publication was denied or unavailable. An app owner must enable Checks: read and write, and the installation owner must approve the updated permission.

@ecc-tools

ecc-tools Bot commented Sep 14, 2026

Copy link
Copy Markdown
Contributor

ECC Tools / PR Risk Taxonomy

Commit: 3e72db8aa524db797024b2931fc9c577616d6c92

PR taxonomy review recommended (neutral)

Detected 2 PR taxonomy bucket(s): Install Manifest Integrity, CI/CD Recommendation.

Scanned 22 changed file(s).

Roadmap taxonomy buckets:

Install Manifest Integrity

Install manifests, plugin metadata, and shipped skills should stay synchronized with user-facing setup guidance.

Signals:

  • 1 install or manifest path(s) changed

Paths:

  • package.json

CI/CD Recommendation

CI, dependency, coverage, and contract signals should be routed into follow-up checks or verification work.

Signals:

  • Dependency or CI drift could surface after merge
  • 2 CI or workflow path(s) changed

Paths:

  • package.json
  • tests/lib/locale-install.test.js
  • manifests/install-components.json
  • manifests/install-modules.json
  • scripts/lib/install-manifests.js

Check publication was denied or unavailable. An app owner must enable Checks: read and write, and the installation owner must approve the updated permission.

@ecc-tools

ecc-tools Bot commented Sep 14, 2026

Copy link
Copy Markdown
Contributor

ECC Tools / Reference Set Readiness

Commit: 3e72db8aa524db797024b2931fc9c577616d6c92

Reference set readiness gaps detected (neutral)

Reference evidence present for 0/7 areas (0%) across 22 changed file(s).

This check is based on files changed in this PR. Repository-level readiness is still reported by /ecc-tools analyze comments and generated manifests.

Area Status Evidence / Next Step
Deep analyzer corpus Missing Add analyzer fixture, golden, benchmark, or reference-set files that can catch analyzer regressions.
RAG/evaluator comparison Missing Add retrieval or evaluator reference-set comparison fixtures with expected ranking behavior.
PR salvage/review corpus Missing Add stale-PR, review-thread, reopen-flow, or salvage reference cases for queue cleanup automation.
Discussion triage corpus Missing Add public discussion triage fixtures, golden cases, or reference sets for informational, answered, and no-response classifications.
Harness compatibility Missing Add cross-harness, adapter-compliance, or harness-audit evidence for Claude, Codex, OpenCode, Zed, dmux, and agent surfaces.
Security evidence Missing Attach security evidence such as SBOMs, SARIF, audit reports, or AgentShield evidence packs.
CI failure-mode evidence Missing Add captured CI failure logs, dry-run fixtures, or troubleshooting docs for common workflow failure modes.

Check publication was denied or unavailable. An app owner must enable Checks: read and write, and the installation owner must approve the updated permission.

@ecc-tools

ecc-tools Bot commented Sep 14, 2026

Copy link
Copy Markdown
Contributor

ECC Tools / Hosted Promotion Readiness

Commit: 3e72db8aa524db797024b2931fc9c577616d6c92

Hosted promotion readiness passed (success)

No hosted promotion evidence gaps detected across 22 changed file(s); 0 corpus scenarios had matching evidence.

This check compares PR file changes against the evaluator/RAG promotion corpus in src/analyzers/fixtures/evaluator-rag-corpus.ts.
Hosted output scoring inspected 0 completed cached hosted job results.

No evaluator corpus scenarios matched this PR.

Check publication was denied or unavailable. An app owner must enable Checks: read and write, and the installation owner must approve the updated permission.

@coderabbitai

coderabbitai Bot commented Sep 14, 2026

Copy link
Copy Markdown
Contributor

Review Change StackReview Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Advanced

Run ID: 64087a02-6991-4fab-b8d3-f687c03fb07c

📥 Commits

Reviewing files that changed from the base of the PR and between 3e72db8 and 071f2db.

📒 Files selected for processing (1)
  • manifests/install-modules.json

Included review availability: Your plan provides up to 10 included reviews per hour; 9 remain after this review.

📜 Recent review details
⏰ Context from checks skipped due to timeout. (37)
  • GitHub Check: Packed Install (windows-latest)
  • GitHub Check: Packed Install (macos-latest)
  • GitHub Check: Greptile Review
  • GitHub Check: Test (macos-latest, Node 22.x, yarn)
  • GitHub Check: Test (macos-latest, Node 22.x, pnpm)
  • GitHub Check: Test (macos-latest, Node 22.x, npm)
  • GitHub Check: Test (macos-latest, Node 22.x, bun)
  • GitHub Check: Test (windows-latest, Node 20.x, yarn)
  • GitHub Check: Test (windows-latest, Node 18.x, npm)
  • GitHub Check: Test (macos-latest, Node 18.x, yarn)
  • GitHub Check: Test (windows-latest, Node 20.x, npm)
  • GitHub Check: Test (macos-latest, Node 20.x, yarn)
  • GitHub Check: Test (ubuntu-latest, Node 18.x, yarn)
  • GitHub Check: Test (macos-latest, Node 20.x, pnpm)
  • GitHub Check: Test (windows-latest, Node 18.x, yarn)
  • GitHub Check: Test (macos-latest, Node 18.x, npm)
  • GitHub Check: Test (ubuntu-latest, Node 20.x, bun)
  • GitHub Check: Test (macos-latest, Node 20.x, bun)
  • GitHub Check: Test (windows-latest, Node 22.x, pnpm)
  • GitHub Check: Test (macos-latest, Node 18.x, bun)
  • GitHub Check: Test (macos-latest, Node 20.x, npm)
  • GitHub Check: Test (ubuntu-latest, Node 22.x, pnpm)
  • GitHub Check: Test (ubuntu-latest, Node 22.x, yarn)
  • GitHub Check: Test (windows-latest, Node 22.x, npm)
  • GitHub Check: Test (windows-latest, Node 22.x, yarn)
  • GitHub Check: Test (macos-latest, Node 18.x, pnpm)
  • GitHub Check: Test (ubuntu-latest, Node 20.x, yarn)
  • GitHub Check: Test (windows-latest, Node 20.x, pnpm)
  • GitHub Check: Test (ubuntu-latest, Node 22.x, npm)
  • GitHub Check: Test (ubuntu-latest, Node 18.x, npm)
  • GitHub Check: Test (ubuntu-latest, Node 22.x, bun)
  • GitHub Check: Test (ubuntu-latest, Node 20.x, pnpm)
  • GitHub Check: Test (ubuntu-latest, Node 18.x, pnpm)
  • GitHub Check: Test (windows-latest, Node 18.x, pnpm)
  • GitHub Check: Test (ubuntu-latest, Node 18.x, bun)
  • GitHub Check: Test (ubuntu-latest, Node 20.x, npm)
  • GitHub Check: Coverage
🧰 Additional context used
📓 Path-based instructions (3)
Lightweight agents with frequent invocation Pair programming and code generation Worker agents in multi-agent systems Main development work Orchestrating multi-agent workflows Complex coding tasks Complex architectural decisions Maximum rea...

📄 CodeRabbit inference engine (.cursor/rules/common-performance.md)

Files:

  • manifests/install-modules.json
NEVER hardcode secrets in source code - ALWAYS use environment variables or a secret manager

📄 CodeRabbit inference engine (.cursor/rules/common-security.md)

Files:

  • manifests/install-modules.json
Do not hardcode secrets, API keys, passwords, or tokens

📄 CodeRabbit inference engine (.github/copilot-instructions.md)

Files:

  • manifests/install-modules.json
🔇 Additional comments (1)
manifests/install-modules.json (1)

1184-1184: LGTM!


📝 Summary

Summary by CodeRabbit

  • New Features

    • Added Polish-language documentation, including a README and terminology glossary.
    • Added Polish to available documentation language selectors.
    • Added support for installing Polish documentation using pl or pl-PL locale options.
    • Included Polish documentation in published packages.
  • Documentation

    • Added guidance covering installation, supported platforms, project concepts, security, contributions, and translation maintenance.

Walkthrough

The PR adds Polish documentation and terminology guidance, links Polish README files from existing language selectors, includes the files in published packages, and adds Polish locale installation metadata, aliases, and tests.

Changes

Polish localization

Layer / File(s) Summary
Polish documentation
docs/pl/README.md, docs/pl/GLOSSARY.md
Adds the Polish ECC README and a glossary for localized terminology.
Translation navigation
README.md, README.zh-CN.md, docs/*/README.md
Adds Polish translation links to existing language selectors.
Polish locale installation
manifests/install-components.json, manifests/install-modules.json, scripts/lib/install-manifests.js, package.json, tests/lib/locale-install.test.js
Adds the locale:pl component, docs-pl module, pl and pl-PL aliases, package inclusion, and installation-plan tests.

Priority: ➖ Normal

Estimated code review effort: 2 (Simple) | ~12 minutes

Change: Feature

Sequence Diagram(s)

sequenceDiagram
  participant CLI
  participant resolveInstallPlan
  participant InstallManifests
  participant PolishDocs
  CLI->>resolveInstallPlan: --locale pl-PL
  resolveInstallPlan->>InstallManifests: resolve locale:pl and docs-pl
  InstallManifests-->>resolveInstallPlan: docs/pl source and install target
  resolveInstallPlan->>PolishDocs: plan docs/pl/README.md installation
Loading

Merge Risk: ⚪ Minimal · up to 071f2

The Polish documentation and locale installation support are internally consistent, with no identified user-facing or publishing failure blocking merge.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 2 functions across 2 files. (1 skipped: 1 … Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely identifies the main change: adding a Polish localization scout.
Description check ✅ Passed The description accurately covers the Polish documentation, installer registration, language navigation updates, tests, and validation results.
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.
Full details: Docstring Coverage

Explanation

Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 2 functions across 2 files. (1 skipped: 1 unsupported.)

  • Fix all pre-merge checks with AI
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

@greptile-apps

greptile-apps Bot commented Sep 14, 2026

Copy link
Copy Markdown
Contributor

RetriggerConfidence Score: 5/5

Safe to merge; no blocking issues remain.

Summary

  • Adds a Polish getting-started/core-concepts guide and terminology glossary under docs/pl/.
  • Adds Polish links to the root and localized README navigation.
  • Registers locale:pl, the docs-pl module, and the pl/pl-PL installer aliases.
  • Includes Polish documentation in the npm publication surface and adds locale-resolution coverage.
  • Narrows the module description to accurately represent the translated scope.

Reviews (2) · Last reviewed commit: "docs(i18n): clarify Polish module scope"

Comment thread manifests/install-modules.json Outdated
@ecc-tools

ecc-tools Bot commented Sep 14, 2026

Copy link
Copy Markdown
Contributor

ECC Tools / Security Evidence

Commit: 071f2dbd28377f8d7736c5623bb86ac46a39f71b

Security evidence gate passed (success)

No security-sensitive scanner-evidence gap detected.

Mode: enforce

Scanned 22 changed file(s). No missing scanner-evidence signal was detected.

Check publication was denied or unavailable. An app owner must enable Checks: read and write, and the installation owner must approve the updated permission.

@ecc-tools

ecc-tools Bot commented Sep 14, 2026

Copy link
Copy Markdown
Contributor

ECC Tools / PR Risk Taxonomy

Commit: 071f2dbd28377f8d7736c5623bb86ac46a39f71b

PR taxonomy review recommended (neutral)

Detected 2 PR taxonomy bucket(s): Install Manifest Integrity, CI/CD Recommendation.

Scanned 22 changed file(s).

Roadmap taxonomy buckets:

Install Manifest Integrity

Install manifests, plugin metadata, and shipped skills should stay synchronized with user-facing setup guidance.

Signals:

  • 1 install or manifest path(s) changed

Paths:

  • package.json

CI/CD Recommendation

CI, dependency, coverage, and contract signals should be routed into follow-up checks or verification work.

Signals:

  • Dependency or CI drift could surface after merge
  • 2 CI or workflow path(s) changed

Paths:

  • package.json
  • tests/lib/locale-install.test.js
  • manifests/install-components.json
  • manifests/install-modules.json
  • scripts/lib/install-manifests.js

Check publication was denied or unavailable. An app owner must enable Checks: read and write, and the installation owner must approve the updated permission.

@ecc-tools

ecc-tools Bot commented Sep 14, 2026

Copy link
Copy Markdown
Contributor

ECC Tools / Reference Set Readiness

Commit: 071f2dbd28377f8d7736c5623bb86ac46a39f71b

Reference set readiness gaps detected (neutral)

Reference evidence present for 0/7 areas (0%) across 22 changed file(s).

This check is based on files changed in this PR. Repository-level readiness is still reported by /ecc-tools analyze comments and generated manifests.

Area Status Evidence / Next Step
Deep analyzer corpus Missing Add analyzer fixture, golden, benchmark, or reference-set files that can catch analyzer regressions.
RAG/evaluator comparison Missing Add retrieval or evaluator reference-set comparison fixtures with expected ranking behavior.
PR salvage/review corpus Missing Add stale-PR, review-thread, reopen-flow, or salvage reference cases for queue cleanup automation.
Discussion triage corpus Missing Add public discussion triage fixtures, golden cases, or reference sets for informational, answered, and no-response classifications.
Harness compatibility Missing Add cross-harness, adapter-compliance, or harness-audit evidence for Claude, Codex, OpenCode, Zed, dmux, and agent surfaces.
Security evidence Missing Attach security evidence such as SBOMs, SARIF, audit reports, or AgentShield evidence packs.
CI failure-mode evidence Missing Add captured CI failure logs, dry-run fixtures, or troubleshooting docs for common workflow failure modes.

Check publication was denied or unavailable. An app owner must enable Checks: read and write, and the installation owner must approve the updated permission.

@ecc-tools

ecc-tools Bot commented Sep 14, 2026

Copy link
Copy Markdown
Contributor

ECC Tools / Hosted Promotion Readiness

Commit: 071f2dbd28377f8d7736c5623bb86ac46a39f71b

Hosted promotion readiness passed (success)

No hosted promotion evidence gaps detected across 22 changed file(s); 0 corpus scenarios had matching evidence.

This check compares PR file changes against the evaluator/RAG promotion corpus in src/analyzers/fixtures/evaluator-rag-corpus.ts.
Hosted output scoring inspected 0 completed cached hosted job results.

No evaluator corpus scenarios matched this PR.

Check publication was denied or unavailable. An app owner must enable Checks: read and write, and the installation owner must approve the updated permission.

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