Skip to content

Latest commit

 

History

History
54 lines (43 loc) · 5.19 KB

CONTRIBUTING.md

File metadata and controls

54 lines (43 loc) · 5.19 KB
Raw

Формулирование проблем

Если возникают какие-то проблемы, то можете писать в gitter-чат.

Join the chat at https://gitter.im/AndreyAkinshin/Russian-Phd-LaTeX-Dissertation-Template

Желательно описывать проблемы с предоставлением минимального рабочего примера (описание минимального примера для задания вопроса, связанного с LaTeX, на русском языке), чтобы желающие вам помочь могли скопировать предоставленный вами код и скомпилировать его, увидев то же, что видите вы. Формулировать желаемые результаты стоит конкретным примером вида «вот что получаю, а вот что хочу получить на выходе».

Если хотите, чтобы решение проблемы поскорее попало в шаблон, то создавайте Issue с предоставлением минимального рабочего примера.

Простые правки

Если вы хотите сделать простую правку (исправить опечатку или дописать что-нибудь полезное в инструкцию по установке), то это можно сделать непосредственно через GitHub. Краткая инструкция:

  1. Форкаете репозиторий: для этого нужно нажать кнопку Fork в правом верхнем углу с любой страницы репозитория.
  2. Переходите к себе в профиль, там у вас будет форк репозитория с диссертацией. Переходите в него, выбираете нужную страничку с инструкцией и тыкаете на карандаш вверху справа (edit this file).
  3. Редактируете файл, сохраняете изменения.
  4. На странице с вашим форком появится большая зелёная кнопка «New Pull Request». Нажимаете её и создаёте Pull Request.

Сложные правки

Если вы хотите сделать сложную правку (например, поправить шаблон), то лучше бы это сделать на локальной машине, проверить, что всё работает, а только после этого сделать Pull Request. Проверить предлагаемые доработки необходимо в трёх компиляторах (pdflatex, xelatex, lualatex), а также двух вариантах работы с библиографией (bibtex и biblatex). Если знакомы с утилитой make, то в корне репозитория прописана инструкция examples для подобной проверки. Вызов make examples попробует собрать автореферат и диссертацию тремя компиляторами в различных вариантах.

Если вы не знакомы с системой контроля версий git, то можно начать со следующей статьи: Pull request'ы на GitHub или Как мне внести изменения в чужой проект.

Стилистика

Желательно:

  • выполнять индентацию четырьмя пробелами, в соответствии с настройками latexindent.

  • не оставлять пробелов в конце строк

  • оставлять в коце файла пустую строку

  • использовать LF (т.е. не CRLF) для перевода строки

    (для Windows, может быть удобно использовать автопреобразование, git config --local core.autocrlf true)

  • использовать UTF-8