Перейти до вмісту

Contributing Guidelines for Our Documentation

📖 Docs

Ви вільно володієте іншою мовою, окрім англійської? Ваш досвід є безцінним для нас! Ми використовуємо README.md для поточного репозиторію та Starlight для нашого спільного веб-сайту документації. Цей чудовий інструмент забезпечує багатомовну підтримку у межах одного сховища. Це означає, що ви можете робити внески до документації бажаною мовою без клопоту з керуванням окремим сховищем. Для отримання детальних вказівок, будь ласка, ознайомтеся з документацією Starlight i18n.

Як зробити внесок

Важливо почати з ознайомлення з нашими настановами щодо внеску, які надають важливу інформацію про внесок у цей проект.

Початок нового перекладу

Якщо наша документація ще не доступна вашою мовою, але ви зацікавлені в її перекладі, ось як ви можете почати:

  1. Визначте або створіть проблему перекладу:.
    • Знайдіть наявне завдання для мови, яку ви хочете перекласти. Якщо такої немає, не соромтеся створити її. Це допоможе уникнути дублювання зусиль і дасть змогу спільноті стежити за перекладом.
    • Якщо ви знайшли вже існуючу тему, будь ласка, залиште коментар, щоб повідомити інших, що ви починаєте переклад. Ми радимо надсилати окремі запити на переклад (PR) для кожного документа, щоб спростити процес перевірки.
  2. Налаштуйте інтернаціоналізацію (i18n):.
    • Переконайтеся, що конфігурація i18n налаштована в Starlight. Якщо ні, налаштуйте її та надішліть PR для цього початкового кроку. Для отримання інструкцій відвідайте «Налаштування i18n».
  3. Ініціюйте процес перекладу: Ініціюйте процес перекладу
    • Скопіюйте файли/теки, які ви маєте намір перекласти, з теки src/content/docs до нової або наявної теки, названої відповідною мовою (наприклад, src/content/docs/de для німецької). Виключіть будь-який вже перекладений код. Starlight автоматично встановить англійську мову для неперекладених документів. Не знаєте код мови? Знайдіть його тут.
  4. **Перекладіть і створіть прес-релізи
    • Перекладіть скопійовані файли і створіть для кожного з них PR або проект PR. Після завершення, позначте PR як готовий до розгляду.

Корисні поради

  • Переклади бічних панелей налаштовуються у файлі astro.config.ts.
  • Після завершення перекладу, будь ласка, позначте запит як готовий до рецензування.

Процес рецензування

Наша мета полягає в тому, щоб кожен PR був переглянутий 1-2 людьми. Це гарантує високу якість документації з єдиним тоном. Якщо ви знаєте когось, хто добре володіє мовою перекладу, попросіть його прорецензувати PR, щоб прискорити процес. Їхній досвід не лише підвищить якість перекладу, але й пришвидшить інтеграцію цінного внеску.

Подяки

Цей документ створено на основі настанов з перекладу t3-oss/create-t3-app та biomejs/biome. Ми дякуємо цим спільнотам за їхні новаторські зусилля у спільному перекладі.