Skip to content
This repository has been archived by the owner on Apr 27, 2020. It is now read-only.

Latest commit

 

History

History
85 lines (59 loc) · 6.35 KB

CONTRIBUTING.md

File metadata and controls

85 lines (59 loc) · 6.35 KB

Расшифровка выпусков подкаста

Участие в расшифровке

  1. Выберите любой из не расшифрованных выпусков, в его ишье выберите ещё не занятые никем темы, которые хотите набирать, и отпишитесь об этом.
  2. Создайте в собственном форке отдельную ветку для выбраных тем.
  3. Наберите выбранные темы выпуска (желательно ознакомиться с советами по набору и форматированию).
  4. При необходимости, синхронизируйтесь с апстримом.
  5. На основе отдельной ветки создайте пулреквест и в его сообщении укажите через решётку номер ишьи (например, для Выпуска №6 — #55) и заголовки набраных тем, если не весь выпуск набирали.

Советы по набору текста

I. Собственно набор

  • Сначала как слышите, так и набирайте, пусть даже с ошибками и без оформления.
  • Пропускайте только совсем явные слова-паразиты.
  • Непонятное помечайте с помощью меток TODO (например, <!-- TODO: Неразборчиво -->) и набирайте дальше.

Если не сможете полностью набрать — укажите место, на котором остановились (например, <!-- TODO: Набрать с 34:16 -->), сделайте коммит и отправьте пулреквест. Это лучше, чем ничего.

II. Редактирование набранного (по возможности)

  • Исправьте собственные ошибки и опечатки. Проще это сделать с помощью YaSpeller:
    1. установите зависимости, запустив npm i в директории подкаста (нужен установленный Node.js);
    2. совершите проверку, запустив npm test;
    3. исправьте ошибки из списка обнаруженных;
    4. правильно набранные слова помеченные как ошибка занесите в файл .yaspellerrc;
    5. после исправлений снова запустите проверку, чтобы убедиться, что ошибок больше нет.
  • Устраните то, что при чтении мешает понять суть сказанного:
    • исправьте оговорки ведущих;
    • уберите подбор слов и фраз;
    • удалите оставшиеся слова-паразиты.
  • В непонятных местах ещё раз сверьтесь с аудио.
  • Самостоятельно на сколько сможете сведите к минимуму количество собственных меток TODO.
  • Литературьте в меру — важно не исказить и не упустить смысл.

Если не сможете отредактировать — ничего страшного, отправьте пулреквест.

Форматирование текста

Минимально необходимое

  • Структура соответствует оглавлению — заголовки только второго уровня, содержат таймкод и название темы, которая в подкасте отбивается заставкой.
  • Внутри главы присутствуют скопированные из оглавления ссылки на новости.
  • Разбиение текста внутри темы только с помощью абзацев.
  • В начале реплики (в коде на отдельной строке) указывается жирным шрифтом имя её автора в сокращённой форме с точкой.
  • В начале нового абзаца одной реплики автор повторно не указывается.

Пример:

## Название темы (00:00)

[ссылка на статью](https://адрес.ссылки)

**Вадим.**
Реплика Вадима. Следующее предложение в том же абзаце.

Продолжение реплики Вадима. Но уже в другом абзаце.

**Оля.**
Реплика Оли…

Желательное и допустимое

  • Ссылки встраиваются в текст.
  • Упоминаемые куски кода обрамляются бэктиками.
  • Пояснения к TODO краткие и понятные всем.
  • Технические термины в изначальной форме латиницей. Если нужно кириллицей, то лучше в соответствии со словарём.

Пример:

Упоминание [статьи](https://адрес.ссылки "Изначальное название ссылки") в речи

Любые `<теги>`, `:селекторы`, `свойства: значения` и вообще всё из кода

Пользуюсь Sass, JS и… <!-- TODO: Незнакомый термин -->

Нежелательное

  • Склонение в терминах, написанных латиницей: Пользуюсь Sass'ом и JS'ом.
  • Выделение внутри реплик жирным и/или курсивом без особой необходимости (допустимо использовать курсив, где автор явно сделал акцент на слове).