#Гайдлайны

Выбор статьи для перевода

Перед началом перевода проверяйте наличие существующих переводов. В частности вы можете использовать сервис: Site Explorer

Маркдаун

Об основах использования маркдауна можно прочесть тут.

Ограничение длинны строки

Что бы редакторам и всем остальным, кто вовлечен в процесс, было удобно работать со статьей, в частности с diff'ами строки следует ограничивать по длине 80 символами. После чего вставляется символ перевода строки. Это можно делать как вручную, так и с помощью плагина для редактора. Если вы используете Sublime Text, то можно использовать плагин @matmuchrapna. Как это сделать написано в статье «Редактирование Markdown в Sublime Text».

Код

Для представления кода просто добавьте слева от каждой строки 4 пробела.

Ссылки

Ссылки в статье имеют вид:

Код вы сможете найти в [репозитории на GitHub][0].
Более подробно об использовании Vibration API можно прочесть [тут][1].

Текст, который находится в первой паре скобок будет текстом внутри ссылки.

Номер во второй паре скобок является уникальным идентификатором URL ссылки в рамках статьи.

После окончания текста статьи содержится список ссылок вида:

[0]: http://github.com/ossreleasefeed/good-vibrations
[1]: http://www.w3.org/TR/vibration/

В скобках содержится уникальный в рамках файла идентификатор URL. После двоеточия находится сам URL.

Изображения

Все изображения в статье должны быть сохранены в директорий img находящийся в репозитории. В разметке используется запись вида:

![Скриншот][Развернутое меню]
![Иллюстрация][Счастливые люди ловят сачками пролетающих мимо утконосов]

В первой паре скобок содержится текст, который будет в атрибуте alt и содержит тип изображения.

Во второй паре скобок содержится описание того, что изображено на изображении, одновременно являющееся уникальным в рамках файла идентификатором.

В конце файла, после списка ссылок, добавляется находится список изображений вида:

[Развернутое меню]: img/main.png "Развернутое меню"
[Счастливые люди ловят сачками пролетающих мимо утконосов]: img/platypus.png "Счастливые люди ловят сачками пролетающих мимо утконосов"

В первой паре скобок содержится уникальный в рамках файла идентификатор изображения.

После двоеточия указан относительный URL изображения в репозитории.

В кавычках находится текст, который будет содержаться в атрибуте title изображения.

Типографика

1. Три точки замените на многоточие: "..." -> "…".
2. Дефисы, отбитые с обеих сторон пробелами, замените на тире: " - " -> " — ".
3. Программистские кавычки замените на правильные русские кавычки: внешние "«…»", внутренние — "„…“".
4. Не забывайте про букву Ё.

По возможности сделайте работу корректора легче и перед коммитом проверьте текст вашей статьи на предмет наличия ошибок с помощью сервисов проверки орфографии, например: Яндекс.Спеллер

Имена собственные

Правила транслитерации имен собственных

Перевод терминов

Для перевода терминов рекомендуется использовать Словарь терминов по фронтенду. Также настоятельно рекомендуется участвовать в формировании словаря.