docs(contributing): document i18n locale field rendering types#656
docs(contributing): document i18n locale field rendering types#656hanthor wants to merge 2 commits into
Conversation
Without thresholds, coverage is collected but never enforced -- a PR that deletes tests still passes CI. Set conservative 50% floors across statements, branches, functions, and lines to start blocking regressions. Closes #651 Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Translators have no way to know which locale keys support Markdown, which accept raw HTML, and which are plain text only. Using the wrong markup produces literal asterisks/tags in the rendered page. Add a "Locale field rendering" subsection under the i18n instructions with three tables covering all 26 Markdown fields, the 2 raw-HTML fields (Bazaar.Description / Bazaar.Additional), and a plain-text note for the remainder. Closes #648 Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
|
Warning Review limit reached
More reviews will be available in 19 minutes and 3 seconds. Learn how PR review limits work. Your organization has run out of usage credits. Purchase more in the billing tab. ⌛ How to resolve this issue?After more reviews become available, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available. Please see our Fair Usage Limits Policy for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (2)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
hanthor
left a comment
hanthor
left a comment
There was a problem hiding this comment.
Code Review
Changes: 2 files (+48 lines). CONTRIBUTING.md (+42) and vite.config.ts (+6).
CONTRIBUTING.md — i18n rendering docs ✅
- ✅ Comprehensive field-type reference with 24 Markdown fields, 2 HTML fields, and plain-text default
- ✅ Clear component attribution for each field
- ✅ Practical guidance — translators can now avoid broken markup
- ✅ Well-positioned after the "Adding a new language" section
vite.config.ts ⚠️
- The coverage thresholds change is identical to PR #655 (closes #651). If #655 merges first, this will cause a trivial merge conflict. If this merges first, #655 becomes redundant. Either merge order works — just ensure only one lands.
Verdict
The CONTRIBUTING.md changes are correct and well-structured. The vite.config.ts overlap with #655 is minor and will self-resolve on merge. LGTM.
1 participant
Summary
Translators have no way to know which locale keys support Markdown, which accept raw HTML, and which are plain text only. Using the wrong markup produces literal asterisks or tags in the rendered page.
Adds a Locale field rendering subsection under the i18n instructions in
CONTRIBUTING.mdwith three tables:marked.parse())Bazaar.Description,Bazaar.Additional— rendered viav-html)Closes #648
Test plan
CONTRIBUTING.mdrenders correctly in GitHub previewSceneUsers.vue,SectionBazaar.vue,SectionFooter.vue)🤖 Generated with Claude Code