|
|
## Формулирование проблем
|
|
|
Если возникают какие-то проблемы, то можете писать в gitter-чат.
|
|
|
|
|
|
[](https://gitter.im/AndreyAkinshin/Russian-Phd-LaTeX-Dissertation-Template?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
|
|
|
|
|
Желательно описывать проблемы с предоставлением [минимального рабочего примера](http://meta.tex.stackexchange.com/questions/228/ive-just-been-asked-to-write-a-minimal-example-what-is-that "Producing a concise Minimal Working Example")
|
|
|
(описание [минимального примера
|
|
|
для задания вопроса](https://dxdy.ru/post1315772.html#p1315772), связанного с LaTeX,
|
|
|
на русском языке), чтобы желающие вам помочь могли скопировать предоставленный
|
|
|
вами код и скомпилировать его, увидев то же, что видите вы. Формулировать
|
|
|
желаемые результаты стоит конкретным примером вида «вот что получаю, а вот что
|
|
|
хочу получить на выходе».
|
|
|
|
|
|
Если хотите, чтобы решение проблемы поскорее попало в шаблон, то создавайте
|
|
|
Issue с предоставлением [минимального рабочего примера](http://meta.tex.stackexchange.com/questions/228/ive-just-been-asked-to-write-a-minimal-example-what-is-that "Producing a concise Minimal Working Example").
|
|
|
|
|
|
## Простые правки
|
|
|
|
|
|
Если вы хотите сделать простую правку (исправить опечатку или дописать
|
|
|
что-нибудь полезное в инструкцию по установке), то это можно сделать
|
|
|
непосредственно через 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 или Как мне внести изменения в чужой проект](http://habrahabr.ru/post/125999/).
|
|
|
|
|
|
## Стилистика
|
|
|
Желательно:
|
|
|
* выполнять индентацию четырьмя пробелами, в соответствии с [настройками latexindent](indent.yaml).
|
|
|
* не оставлять пробелов в конце строк
|
|
|
* оставлять в коце файла пустую строку
|
|
|
* использовать `LF` (т.е. не `CRLF`) для перевода строки
|
|
|
|
|
|
(для Windows, может быть удобно использовать [автопреобразование](https://git-scm.com/book/ru/v1/%D0%9D%D0%B0%D1%81%D1%82%D1%80%D0%BE%D0%B9%D0%BA%D0%B0-Git-%D0%9A%D0%BE%D0%BD%D1%84%D0%B8%D0%B3%D1%83%D1%80%D0%B8%D1%80%D0%BE%D0%B2%D0%B0%D0%BD%D0%B8%D0%B5-Git#%D0%A4%D0%BE%D1%80%D0%BC%D0%B0%D1%82%D0%B8%D1%80%D0%BE%D0%B2%D0%B0%D0%BD%D0%B8%D0%B5-%D0%B8-%D0%BF%D1%80%D0%BE%D0%B1%D0%B5%D0%BB%D1%8C%D0%BD%D1%8B%D0%B5-%D1%81%D0%B8%D0%BC%D0%B2%D0%BE%D0%BB%D1%8B), `git config --local core.autocrlf true`)
|
|
|
* использовать UTF-8
|