Руководство по внесению изменений в документацию Floorp
Спасибо за интерес к улучшении документации Floorp!
Перед началом работы изучите существующий контент чтобы избежать дублирования.
Типы вклада
Добавление контента
Перед написанием нового материала проверьте, есть ли уже такая тема в нашей документации. Если есть, лучше улучшить существующий контент вместо создания дубликатов. При добавлении новой документации пишите так, чтобы это было понятно как пользователям, так и разработчикам.
Добавление контента
Если заметили ошибку в документации, можете либо сообщить о ней, создав новый тикет с четким описанием проблемы, либо исправить самостоятельно и отправить изменения через pull request. При отправке исправлений обязательно упоминайте связанные тикеты, чтобы мы могли связать их между собой.
Для этого:
- Откройте тикет с описанием проблемы или
- Отправьте pull request с исправлением
Переводы
Мы ценим переводы, которые сочетают естественную читаемость с технической точностью.
Требования к переводам:
-
Естественная адаптация: Переводы должны читаться так, будто изначально написаны на целевом языке, с соответствующей структурой предложений. Избегайте дословных переводов, когда они звучат неестественно.
-
Техническая согласованность: Вся браузерная терминология (например, "Расширения", "Рабочие пространства", "Боковая панель") должна использовать официальные переводы, где они существуют. Для новых/непереведенных терминов поддерживайте согласованность во всей документации.
-
Структурное соответствие: Переведенные страницы должны следовать структуре оригинальных английских файлов.
Процесс внесения вклада:
- Проверьте существующие переводы (e.g.,
docs/en/) - Для новых языков создайте папку, используя правильный код ISO 639-1 code
- Отправьте изменения через pull request
Как внести вклад
- Форкните репозиторий
- Создайте ветку для ваших изменений
- Внесите изменения с понятными комментариями к коммитам
- Создайте pull request
Спасибо за помощь в улучшении документации Floorp!