Skip to content

Latest commit

 

History

History
45 lines (31 loc) · 5.79 KB

translation_guide.md

File metadata and controls

45 lines (31 loc) · 5.79 KB
Raw

Руководство по переводу

Пожалуйста, придерживайтесь его при переводе или редактировании существующих переводов.

Общие правила

  • Вы и его производные пишите с маленькой буквы.
  • Всегда используйте букву ё.
  • Переводите комментарии в примерах кода. По желанию (но не обязательно) можете перевести содержимое в примерах.
  • Необязательно, но рекомендуется исправить стиль кода в примерах переводимой статьи (как минимум, добавить пробелы после назначения переменных, управляющих констукций, сюда относится добавление табуляции, если она отсутствует).
  • Названия пишите в оригинальном виде: javascript должно быть написано как JavaScript, Github — GitHub и т.д.
  • Иностранные имена переводите с указанием оригинального имени в скобках: Эван Ю (Evan You). При этом обязательно проверьте уже существующий перевод имени в словаре имён «Веб-стандартов», а если его нет — пожалуйста, добавьте его, создав пулреквест.
  • Заголовки при переводе пишете со строчной буквы, если в оригинале каждое слово в заголовке написано с прописной буквы: Type Annotations переводить как Аннотация типов, а не Аннотация Типов.
  • Используйте тире вместо дефиса (оно должно быть намного длиннее, чем дефис). Тире: —, дефис: -

Соглашения по переводу

В таблице ниже перечислены соглашения по переводу некоторых терминов и названий (включая их производные). Эту таблицу следует считать расширением словаря «Веб-стандартов», которому должны следовать все переводы.

Что Как переводить
cache кеш
slash слеш
callback коллбэк
hash хеш
ID идентификатор

Ресурсы для помощи в переводе

  • Для проверки правильности написания можно использовать Грамоту.ру.
  • В качестве онлайн-словаря можно использовать Мультитран.

Команды для облегчения процесса перевода

Используйте yarn или npm, в зависимости от ваших предпочтений, это не принципиально, в примерах ниже используется yarn:

  • yarn run create-sample — команда для создания образца статьи, которая создаст папку (на основе оригинального названия статьи) и файл с таким содержимым, опционально она может создать новую ветку для статьи и сразу в неё перейти.
  • yarn run lint-staged — проверка опечаток через сервис Яндекс.Спеллер. Возможны ошибки, связанные с используемыми в статье словами, про которые не знает этот сервис (см. здесь для решения этой проблемы).
  • yarn run publish — команда отправки статьи на публикацию в Medium devSchacht. В качестве аргумента ей нужно передать путь к статье. В первый раз потребуется генерация токена Medium, который сохранится на компьютере и больше требоваться не будет.

Возможные проблемы

Добавление нового слова в файл исключений

Поскольку при открытии пулреквеста с переводом он проходит автоматическую проверку на опечатки с помощью сервиса Яндекс.Спеллер, то некоторые слова (например, при переводе на русский имен автора статьи) он может маркировать как ошибочные. Если это произошло, добавьте такое слово в файл исключений, соблюдая алфивитный порядок.