Подготовка

  1. Зарегистрируйся на github.

  2. Уже можно помогать в поиске опечаток и идеями :)

У любого проекта есть раздел issues. Например, github.com/bdemeshev/probability_dna/issues. В этом разделе можно сообщить автору об опечатках или предложить новую мысль :)

  1. Установи систему контроля версий git.

3а. Windows или Mac. Удобный для новичка вариант git с графической оболочкой можно установить на desktop.github

3б. На Линукс система контроля версий git установлена по умолчанию. Если охота дополнить командную строку графическим интерфейсом, то можно дополнительно поставить gitkraken, но суровые челябинские жители обходятся только командной строкой.

Правка открытого проекта в первый раз

  1. Сделай себе онлайн копию (fork) проекта, в который ты хочешь внести вклад.

  2. Склонируй (clone) свою копию проекта себе на жёсткий диск.

  3. Внеси предлагаемые изменения у себя на жестком диске.

  4. Отправь (push) правки со своего жёсткого диска в свою онлайн копию проекта.

  5. Попроси автора проекта принять твои правки (pull-request).

Правка открытого проекта во второй раз

  1. Стащи (pull) в свою онлайн копию проекта все свежие правки сделанные автором в оригинале.

  2. Стащи (pull) свежие правки автора из своей онлайн копии себе на жёсткий диск.

  3. Внеси предлагаемые изменения у себя на жестком диске.

  4. Отправь (push) правки со своего жёсткого диска в свою онлайн копию проекта.

  5. Попроси автора проекта принять твои правки (pull-request).

Особенности репозиториев с задачками Бориса Демешева

Texlive

Все задачки написаны в техе :) Редактировать файлы можно в онлайн-сервисе типа overleaf.com или локально без интернета. Чтобы редактировать задачки локально потребуется дистрибутив теха. Я советую texlive. Инструкция по установке есть :)

Шрифт Linux Libertine

Мне нравится шрифт Linux Libertine O. Он открытый, не такой приевшийся как Times New Roman или Colibri и просто няшный :)

Установить шрифт легко!

1а. Установка под Windows.

1б. Установка под macos.

1в. Установка под Linux.

Наличие make-файла

Make-файл позволяет из исходного текста получить готовый файл. Обычно программисты используют их, чтобы из исходников на C++ получить готовую для пользователя программу.

Система make-файлов по умолчанию используется на linux и macos. Пользователям Windows следует дополнительно поставить …

Каждый репозиторий содержит make-файл. В этом файле содержатся все команды, которые превращают tex-исходники в готовый pdf-файл. Чтобы увидеть свои изменения в готовом виде в pdf-файле достаточно:

  1. Внести изменения в tex-исходник и сохранить их :)

  2. Запустить командную строку и переместиться в нужную папку.

  3. Выполнить команду make и подождать. При везении получится готовый и симпатичный pdf :)

  4. Если выполнение make привело к ошибкам, то разумно:

4а. Выполнить make clean.

4б. Попробовать удалить часть внесённых правок, чтобы понять, какой именно кусок правок приводит к ошибке.

Пример действий нуба-ассистента

Начинающий ассистент Афанасий обнаружил Страшную опечатку в сборнике «Вероятностная ДНК» и дрожащими руками решил исправить её!

XKCD: trying to fix problems

XKCD: trying to fix problems

  1. Сначала Афанасий зарегистрировался на github.com.

  2. Потом Афанасий сообщил об опечатке и своём желании её исправить в

  3. У ученика Афанасия windows (linux поставить он почему-то боится, а на новый мак ему ещё предстоит работать несколько месяцев в макдо) поэтому Афанасий поставил Github Desktop, texlive и … (для мейк-файлов)

  4. Афанасий осознал ущербность заюзанных Колибри и Times New Roman и установил шрифт Linux Libertine.

  5. Афанасий залогинился на github.com, зашёл в репозиторий probability_dna и храбро кликнул кнопку fork в правом верхнем углу.

В этот момент Афанасий ужаснулся!!!

XKCD: How well something works

XKCD: How well something works