Docs: Add file paths to the new language guide#7454
Docs: Add file paths to the new language guide#7454sriramveeraghanta merged 2 commits intomakeplane:previewfrom
Conversation
WalkthroughThe Changes
Estimated code review effort1 (~2 minutes) Poem
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
|
✅ Improve clarity of file paths for new language guide |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
CONTRIBUTING.md (2)
196-201: Add a trailing comma to future-proof the snippet.
A trailing comma after the last object literal ({ label: "Your Language", value: "your-lang" },) minimises diff noise when more languages are appended.- { label: "Your Language", value: "your-lang" } + { label: "Your Language", value: "your-lang" },
214-221: Consider documenting a dynamic import pattern to reduce switch-case churn.
For growing language lists, the switch statement quickly becomes verbose. Mentioning an alternative keeps the guide future-proof:private importLanguageFile(language: TLanguage) { return import(`../locales/${language}/translations.json`); }Even if you keep the current example, a short note about this pattern can steer contributors toward a scalable solution.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
CONTRIBUTING.md(1 hunks)
🧠 Learnings (1)
CONTRIBUTING.md (1)
Learnt from: janreges
PR: #6743
File: packages/i18n/src/store/index.ts:160-161
Timestamp: 2025-03-11T19:42:41.769Z
Learning: In the Plane project, the file 'packages/i18n/src/store/index.ts' already includes support for Polish language translations with the case "pl".
🧰 Additional context used
🧠 Learnings (1)
CONTRIBUTING.md (1)
Learnt from: janreges
PR: #6743
File: packages/i18n/src/store/index.ts:160-161
Timestamp: 2025-03-11T19:42:41.769Z
Learning: In the Plane project, the file 'packages/i18n/src/store/index.ts' already includes support for Polish language translations with the case "pl".
🔇 Additional comments (1)
CONTRIBUTING.md (1)
189-192: File-path annotation is a welcome clarity boost – looks good.
The inline comment with the full path removes any ambiguity for first-time contributors.
* improve the comprehensiblity of translation contribution docs * Update CONTRIBUTING.md to fix the code blocks appeareance
2 participants
Description
The documentation on Adding new languages references language definition and configuration files without showing their full paths. This can be confusing for contributors, who then have to search the repository to find the correct files, adding unnecessary friction to the process.
Solution
This change adds the full, project-relative paths as comments directly within the code blocks. This provides immediate context and helps contributors locate the files quickly and without ambiguity.
Before:
After:
Type of Change
Screenshots and Media (if applicable)
Test Scenarios
References
Summary by CodeRabbit