Skip to content

docs(contributing): document i18n locale field rendering types #656

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
hanthor wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs(contributing): document i18n locale field rendering types #656

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f94dfd2
fix(ci): add vitest coverage thresholds to prevent silent regression
hanthor May 29, 2026
ce4d858
docs(contributing): document i18n locale field rendering types
hanthor May 29, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 42 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,48 @@ npm run typecheck # Type-check with vue-tsc
3. Translate all values — keep all keys identical to `enUS.json`
4. Open a PR; CI will validate the JSON schema

### Locale field rendering

Not all locale fields are rendered the same way. Using the wrong markup in a field produces broken output.

**Markdown fields** — support `**bold**`, `[links](url)`, `_italic_`, etc. (rendered via `marked.parse()`):

| Key | Component |
|-----|-----------|
| `Users.Features` | SceneUsers.vue |
| `Devs.TowerJoke` | SceneDevelopers.vue |
| `Devs.RuntimeContainers` | SceneDevelopers.vue |
| `Devs.CNJourney` | SceneDevelopers.vue |
| `Mission.Text.Change` | SectionMission.vue |
| `Mission.Text.CloudNative` | SectionMission.vue |
| `Mission.Text.Sustainability` | SectionMission.vue |
| `Mission.CleverGirl` | SectionMission.vue |
| `TryBluefin.Description` | ImageChooser.vue |
| `TryBluefin.Description.Choice` | ImageChooser.vue |
| `TryBluefin.Description.Updates` | ImageChooser.vue |
| `TryBluefin.Download.Documentation.Intro` | ImageChooser.vue |
| `TryBluefin.Download.Documentation.Downloads` | ImageChooser.vue |
| `TryBluefin.Download.Documentation.SecureBoot` | ImageChooser.vue |
| `Video.Text.Passion` | SceneContent.vue |
| `Video.Text.StateOfTheArt` | SceneContent.vue |
| `Footer.Credits.Intro` | SectionFooter.vue |
| `Footer.Credits.Wallpapers` | SectionFooter.vue |
| `Footer.Credits.Website` | SectionFooter.vue |
| `Footer.Credits.Logos` | SectionFooter.vue |
| `Footer.Credits.Thanks` | SectionFooter.vue |
| `Footer.Credits.Translations` | SectionFooter.vue |
| `Footer.Credits.ImageEdit` | SectionFooter.vue |
| `Footer.Project.Ublue` | SectionFooter.vue |

**Raw HTML fields** — use `<a href="...">link</a>` directly; Markdown syntax will appear literally (rendered via `v-html`):

| Key | Component |
|-----|-----------|
| `Bazaar.Description` | SectionBazaar.vue |
| `Bazaar.Additional` | SectionBazaar.vue |

**Plain text fields** — all other keys. Markdown and HTML tags will appear as literal characters. Do not use markup.

## Testing

Run tests locally before opening a PR.
Expand Down
6 changes: 6 additions & 0 deletions vite.config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,12 @@ export default defineConfig({
coverage: {
provider: 'v8',
reporter: ['text', 'lcov'],
thresholds: {
statements: 50,
branches: 50,
functions: 50,
lines: 50,
},
},
},
plugins: [
Expand Down