- Файл
rules.tex
- корневой файл для PDF-документа, в него включаются все остальные файлы. - Для сборки используется среда TexLive, правила написаны с использованием языка разметки LaTeX и компилятора lualatex.
- Файл
index.html
- корневой файл для сайта. В нем должна быть ссылка на собранный файл правил (rules.pdf
) и любые вспомогательные сведения (списки действующих судей, контакты комитета по правилам).
Для обновления следует создать новую ветку в репозитории и внести изменения. Не забудьте обновить версию правил в файле rules.tex
, указав новую дату выпуска и увеличив номер версии. Номер версии следует менять в минорной части (после точки, например, 1.2 -> 1.3) если изменения в правилах незначительны и связаны с уточнением терминов и ситуаций. В случае, если изменения существенны, увеличить следует мажорную часть, а минорную сбросить до нуля (до точки, например, 1.1 -> 2.0).
После того, как ветка вливается в мастер, запускается автоматическая сборка PDF-файла правил, релиз его в раздел Releases текущего репозитория и релиз файлов index.html
и rules.pdf
на общедоступный вебсайт (https://ru.riichimahjong.org).