docs: add Japanese README - #43
Merged
Merged
Conversation
Adds README.ja.md as a maintained Japanese counterpart to the English README, and a language selector to the top of both files. The translation mirrors the English original section for section: download channels, distribution formats, core features, portable mode, build and test commands, privacy and security, code signing policy, and license and upstream notices. It links to the Japanese website at https://winterm.dev/ja/. Facts are taken from the current README rather than restated: the source version 1.3.0-beta3, the latest stable release 1.2.0, the beta prerelease tag, the asset filename patterns, SHA256SUMS.txt, and the pinned upstream baseline. Commands, filenames, executable names, JSON setting names, version strings, hashes, release URLs, and relative documentation links are preserved verbatim, and the single code block is byte-identical to the English one. Every disclosure is carried over rather than softened: the unsigned installer and SmartScreen warning, the checksum verification step, the current "not Authenticode-signed" status, the exact SignPath attribution sentence, and the Microsoft non-affiliation disclaimer. Links to English-only documentation are labelled （英語）, and the README states that winTerm-specific new features still display some English text, which matches the actual ja-JP resource coverage. Validation: - scripts/winterm/verify-version.ps1 gains eleven checks covering the two language links, the website link, both version references, the checksum filename, the signing disclosures, the SignPath attribution, the non-affiliation disclaimer, and the upstream baseline. The script passes. - README.ja.md added to the documentation allowlist in ChangeClassification.psm1, so a translation-only change classifies as docs-only. scripts/winterm/test-ci-classification.ps1 passes. - All 21 relative links in README.ja.md resolve, and the file is UTF-8 with LF endings and no BOM. No application code, resource, or version file changed, and no release was produced. The changelog records this under Unreleased rather than fabricating a version.
The Japanese README checks embedded Japanese string literals in verify-version.ps1, making it the only non-ASCII PowerShell file in the repository. Test-PowerShellSyntax parses scripts with Parser::ParseFile, which decodes a BOM-less file using the host's active code page; on the CI runner that corrupted the literals and reported "Missing ')' in method call", failing quick validation. The file parsed cleanly on a UTF-8 host, so the failure only appeared in CI. The checks now use ASCII literals only, matching every other PowerShell file here, and verify the same facts through the ASCII tokens the Japanese prose contains: both language links, the website link, the source and stable versions, the installer and portable asset patterns, the checksum filename, SmartScreen, Authenticode, the SignPath attribution, Microsoft, portable.marker, and the upstream baseline. Three checks replace what the Japanese literals used to guarantee, so an English copy or a mis-encoded file still cannot pass: the file must have no UTF-8 BOM, must decode as strict UTF-8, and must contain more than 500 kana and kanji characters. It currently contains 2713. Verified: Parser::ParseFile reports 0 errors, the file contains 0 non-ASCII bytes, verify-version.ps1 passes all 17 Japanese README checks, and test.ps1 -Suite Smoke passes locally.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds
README.ja.md, a maintained Japanese counterpart to the English README, and a language selector at the top of both files. Documentation only.README.ja.mdA complete counterpart rather than a marketing summary. It mirrors the English README section for section:
# winTermwith the same badges## winTermをダウンロード## 配布形式## 主な機能## ポータブルモード## ビルドとテスト## プライバシーとセキュリティ## コード署名ポリシー## ライセンスとアップストリーム## サポートと関連ドキュメントLanguage switch
README.mdnow starts withEnglish | [日本語](README.ja.md)README.ja.mdstarts with[English](README.md) | 日本語README.mdis not renamed; the change to it is a two-line addition.Content parity approach
Facts are taken from the current README at implementation time, not restated from memory:
1.3.0-beta3, latest stable1.2.0v1.3.0-beta3and its GitHub URLwinTerm-<version>-setup-x64.exeandwinTerm-<version>-portable-x64.zipSHA256SUMS.txtrelease-1.25@1cea42d433253d95c4487a3037db48197b5e72f4Preserved verbatim: all commands, filenames, executable names, JSON setting names (
shellIntegration.autoInject), version strings, hashes, keyboard shortcuts (Ctrl+Tab), paths (%LOCALAPPDATA%\winTerm,portable.marker), release URLs, and relative documentation links. The single PowerShell code block is byte-identical to the English one — verified programmatically.PowerShell,Command Prompt,WSL,Windows Terminal,GitHub,SignPath, andMicrosoftare left untranslated.Nothing was softened to make the translation more promotional. Every disclosure is carried over:
SHA256SUMS.txtPRIVACY.mdand the English README exactlyLinks to English-only documentation are labelled （英語）. A closing note states that repository documentation and the application UI are not fully available in Japanese, and that winTerm-specific new features still display some English text — which matches the actual
ja-JPresource coverage (1303 of 1421 keys, with all 25 Command Timeline keys untranslated).Changelog and Wiki
CHANGELOG.mdgains an## Unreleasedsection with a### Documentationsubsection recordingREADME.ja.md, the language selector, the Japanese website link, and the validation changes. No release version was fabricated and no application version file was touched.Development-Changes.mdledger entry is published perdocs/development/changelog-policy.md(wiki commits0162c7dandf00552c), recording the date, branch commit SHAs, summary, validation, and build-cost result. It must be updated to the final merge or squash SHA once this PR lands, and the entry says so.Validation
scripts/winterm/verify-version.ps1scripts/winterm/test-ci-classification.ps1README.ja.mdREADME.mdREADME.mdThe seventeen checks added to
verify-version.ps1cover: both language links, the website link, the source version (derived fromversion.json, not hardcoded), the stable1.2.0reference, the installer and portable asset patterns, the checksum filename, the unsigned-installer disclosure, the current signing status, the exact SignPath attribution, the Microsoft non-affiliation disclaimer,portable.marker, and the pinned upstream baseline. Three further guards keep an English or mis-encoded copy from passing: no UTF-8 BOM, strict UTF-8 decoding, and more than 500 kana and kanji characters (currently 2713). No new testing dependency was added.The checks are written with ASCII literals only. The first version embedded Japanese string literals, which made
verify-version.ps1the only non-ASCII PowerShell file in the repository;Test-PowerShellSyntaxparses scripts withParser::ParseFile, which decodes a BOM-less file using the host's active code page, so the literals were corrupted on the CI runner and quick validation failed even though the file parsed cleanly on a UTF-8 host. Commit776edb633restores ASCII-only literals and verifies the same facts structurally.README.ja.mdwas also added to the conservative documentation allowlist inscripts/winterm/ci/ChangeClassification.psm1, so a future translation-only change classifies asdocs-onlyrather than falling through to a heavier class.No application change
No application code, resource, or version file changed. The diff is five files:
README.ja.md(new),README.md,CHANGELOG.md,scripts/winterm/verify-version.ps1, andscripts/winterm/ci/ChangeClassification.psm1. No release was produced and no version was bumped.Build label
The
buildlabel was not added. Running the classifier over this exact change set returns:CI confirms this on the pull request:
Classify exact change set,Quick source and smoke validation, andci-gateall pass, whilex64 Debug build and compiled testsandx64 Release build, tests, and downloadable distributionsboth report skipping. The expensive native build workflow does not run.