fix(readme): replace GB flag with US flag for English section (#126)
* fix(readme): replace GB flag with US flag for English section * fix(create-readme): validate US English flag header in validateReadme * docs(handoff): set PR number --------- Co-authored-by: opencode-agent <agent@opencode.local>
This commit is contained in:
parent
7249f1fcb5
commit
1bd089936e
5 changed files with 35 additions and 3 deletions
|
|
@ -79,7 +79,7 @@ repos/{owner}/{repo}/contents/README.md` с base64-контентом и SHA.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 🇬🇧 English
|
## 🇺🇸 English
|
||||||
|
|
||||||
<!-- summary-en:start -->
|
<!-- summary-en:start -->
|
||||||
### ❓ Why
|
### ❓ Why
|
||||||
|
|
|
||||||
|
|
@ -59,7 +59,7 @@ function generateReadme(args: CreateArgs): string {
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 🇬🇧 English
|
## 🇺🇸 English
|
||||||
|
|
||||||
<!-- summary-en:start -->
|
<!-- summary-en:start -->
|
||||||
### ❓ Why
|
### ❓ Why
|
||||||
|
|
@ -149,6 +149,8 @@ function validateReadme(content: string): { ok: boolean; issues: string[] } {
|
||||||
issues.push("Missing [Русский] language switcher link")
|
issues.push("Missing [Русский] language switcher link")
|
||||||
if (!content.includes("## 🇷🇺 Русский"))
|
if (!content.includes("## 🇷🇺 Русский"))
|
||||||
issues.push("Missing '## 🇷🇺 Русский' header (should be 'Русский', not 'Русская версия')")
|
issues.push("Missing '## 🇷🇺 Русский' header (should be 'Русский', not 'Русская версия')")
|
||||||
|
if (!content.includes("## 🇺🇸 English"))
|
||||||
|
issues.push("Missing '## 🇺🇸 English' header")
|
||||||
if (!content.includes("[Русский](#-русский)"))
|
if (!content.includes("[Русский](#-русский)"))
|
||||||
issues.push("Missing or wrong [Русский](#-русский) switcher link (should be #-русский, not #-русская-версия)")
|
issues.push("Missing or wrong [Русский](#-русский) switcher link (should be #-русский, not #-русская-версия)")
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -5,7 +5,7 @@
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 🇬🇧 English
|
## 🇺🇸 English
|
||||||
|
|
||||||
<!-- summary-en:start -->
|
<!-- summary-en:start -->
|
||||||
### ❓ Why
|
### ❓ Why
|
||||||
|
|
|
||||||
13
docs/decisions/056-pr-126-replace-gb-flag-with-us.md
Normal file
13
docs/decisions/056-pr-126-replace-gb-flag-with-us.md
Normal file
|
|
@ -0,0 +1,13 @@
|
||||||
|
# ADR-056: Replace GB flag with US flag for English section
|
||||||
|
|
||||||
|
## Статус
|
||||||
|
Accepted (2026-07-29)
|
||||||
|
|
||||||
|
## Контекст
|
||||||
|
README English section used British flag 🇬🇧, but project uses American English. Inconsistency between flag and language variant.
|
||||||
|
|
||||||
|
## Решение
|
||||||
|
Replace 🇬🇧 with 🇺🇸 in all README templates (README.md, create-readme.ts, SKILL.md). Add validation check in `validateReadme()` to enforce `## 🇺🇸 English` header in future READMEs.
|
||||||
|
|
||||||
|
## Альтернативы
|
||||||
|
—
|
||||||
17
docs/handoff/pr-126-replace-gb-flag-with-us.md
Normal file
17
docs/handoff/pr-126-replace-gb-flag-with-us.md
Normal file
|
|
@ -0,0 +1,17 @@
|
||||||
|
---
|
||||||
|
pr: 126
|
||||||
|
title: Replace GB flag with US flag for English section
|
||||||
|
---
|
||||||
|
|
||||||
|
## Что сделано
|
||||||
|
- Заменён флаг 🇬🇧 → 🇺🇸 в заголовке `## ... English` в README.md, шаблоне create-readme.ts и reference-блоке SKILL.md
|
||||||
|
- Добавлена validation check в `validateReadme()` для заголовка `## 🇺🇸 English`
|
||||||
|
|
||||||
|
## Почему
|
||||||
|
Британский флаг не соответствует американскому английскому, используемому в проекте. Validation check гарантирует, что future README files используют правильный флаг.
|
||||||
|
|
||||||
|
## Pending
|
||||||
|
—
|
||||||
|
|
||||||
|
## Watch out
|
||||||
|
—
|
||||||
Loading…
Add table
Reference in a new issue