Skip to content

docs(readme): add Russian localized README - #638

Closed
kaya-abdullah wants to merge 2 commits into
mainfrom
docs/add-russian-readme
Closed

docs(readme): add Russian localized README#638
kaya-abdullah wants to merge 2 commits into
mainfrom
docs/add-russian-readme

Conversation

@kaya-abdullah

Copy link
Copy Markdown
Member

Description

Adds a Russian localized README (README_ru.md), following the same abridged-translation pattern already used by README_zh.md / README_ja.md / README_es.md rather than a full line-for-line translation of README.md. Links it from the language nav in all four existing README files, registers it in the readme-check.mjs drift guard's LOCALIZED list, and fixes a pre-existing gap where README_es.md (and now README_ru.md) were missing from the places that name the localized READMEs by file (CONTRIBUTING.md, docs/ADDING_A_PROVIDER.md's provider checklist, the readme-check CI step comment).

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update
  • Code refactoring
  • Performance improvement
  • Test addition or update

Related Issue

N/A, no linked issue; a direct docs addition, not a community contribution.

Changes Made

  • Added README_ru.md (abridged, matches the scope of README_zh.md/README_ja.md/README_es.md, not a full translation of README.md)
  • Added the Русский link to the language nav in README.md, README_es.md, README_zh.md, README_ja.md
  • Added README_ru.md to scripts/readme-check.mjs's LOCALIZED array, and updated its header comment (which was hardcoded to a stale "three files" count) and the CI step comment in .github/workflows/ci.yml
  • Added README_es.md and README_ru.md to the two places in CONTRIBUTING.md and the provider checklist in docs/ADDING_A_PROVIDER.md that only named README_zh.md/README_ja.md

Testing

  • I have tested this locally
  • I have added/updated tests
  • All existing tests pass

Docs-only change; no new executable lines, so no new tests. Ran locally: bun run format, bun run lint, bun run typecheck, bun run knip, bun run readme:check, bun run chart:check, bun run channels:showcase:check, bun run security:check, and bun test tests/unit/readme-check.test.ts (27/27 pass), all clean. Did not run the full bun run test / bun run build; CI will cover those.

Test Environment

  • LibreDB Studio Version: main @ a7212a8
  • Browser: N/A (docs only)
  • OS: Linux
  • Node.js/Bun Version: Bun 1.3.10
  • Database Type: N/A

Screenshots (if applicable)

N/A

Checklist

  • My code follows the project's code style guidelines
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have updated the documentation accordingly
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published

Additional Notes

README_ru.md deliberately omits the same fast-moving sections the other three locales already omit (Roadmap, Sponsors/Supporters, full Environment Variables table, Seed Connections YAML, Display Masking preview) to stay consistent with the existing abridgement precedent, not as an oversight.

Adds README_ru.md following the same abridged-translation pattern as
README_zh.md/README_ja.md/README_es.md, links it from the language nav
in all four existing README files, and registers it in the
readme-check.mjs drift guard's LOCALIZED list.
CONTRIBUTING.md, docs/ADDING_A_PROVIDER.md's provider checklist, and the
readme:check CI step comment named only README_zh.md/README_ja.md, a
leftover from #317 before README_es.md existed. Lists them all now so
the next provider addition doesn't skip the two newer locales.
@kaya-abdullah
kaya-abdullah force-pushed the docs/add-russian-readme branch from b82fb51 to e2a611d Compare September 7, 2026 21:43
@kaya-abdullah

kaya-abdullah commented Sep 7, 2026

Copy link
Copy Markdown
Member Author

Closing without merging. This duplicates open issue , which is curated for Hacktoberfest and intended for a community/junior contributor to pick up (with the explicit requirement that it not read as machine-translated output). Leaving it to that issue instead.

@kaya-abdullah
kaya-abdullah deleted the docs/add-russian-readme branch September 7, 2026 21:46
@sonarqubecloud

sonarqubecloud Bot commented Sep 7, 2026

Copy link
Copy Markdown

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