Mirrors/plane
1
0
Fork 0
mirror of https://github.com/makeplane/plane.git synced 2025-12-16 11:57:56 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: add file paths to the new language guide (#7454)

Browse Source 
* improve the comprehensiblity of translation contribution docs

* Update CONTRIBUTING.md to fix the code blocks appeareance
This commit is contained in:
merrime-n
2025-07-24 12:12:49 +03:30
committed by GitHub
parent d7e58a60fa
commit 56e4d2c6f1
1 changed files with 23 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

48
CONTRIBUTING.md
View File

@@ -186,41 +186,39 @@ Adding a new language involves several steps to ensure it integrates seamlessly
1. **Update type definitions** 1. **Update type definitions**
Add the new language to the TLanguage type in the language definitions file: Add the new language to the TLanguage type in the language definitions file:
```typescript ```ts
// types/language.ts // packages/i18n/src/types/language.ts
export type TLanguage = "en" | "fr" | "your-lang"; export type TLanguage = "en" | "fr" | "your-lang";
``` ```
2. **Add language configuration** 1. **Add language configuration**
Include the new language in the list of supported languages: Include the new language in the list of supported languages:
```ts
// packages/i18n/src/constants/language.ts
export const SUPPORTED_LANGUAGES: ILanguageOption[] = [
{ label: "English", value: "en" },
{ label: "Your Language", value: "your-lang" }
];
```
```typescript 2. **Create translation files**
// constants/language.ts
export const SUPPORTED_LANGUAGES: ILanguageOption[] = [
{ label: "English", value: "en" },
{ label: "Your Language", value: "your-lang" }
];
```
3. **Create translation files**
1. Create a new folder for your language under locales (e.g., `locales/your-lang/`). 1. Create a new folder for your language under locales (e.g., `locales/your-lang/`).
2. Add a `translations.json` file inside the folder. 2. Add a `translations.json` file inside the folder.
3. Copy the structure from an existing translation file and translate all keys. 3. Copy the structure from an existing translation file and translate all keys.
4. **Update import logic** 3. **Update import logic**
Modify the language import logic to include your new language: Modify the language import logic to include your new language:
```ts
```typescript private importLanguageFile(language: TLanguage): Promise<any> {
private importLanguageFile(language: TLanguage): Promise<any> { switch (language) {
switch (language) { case "your-lang":
case "your-lang": return import("../locales/your-lang/translations.json");
return import("../locales/your-lang/translations.json"); // ...
// ... }
} }
} ```
```
### Quality checklist ### Quality checklist