Стиль файлов репозитория
Документ фиксирует базовые правила редактирования файлов сайта.
EditorConfig
В корне проекта добавлен файл .editorconfig.
Он задает единый стиль:
- кодировка UTF-8;
- переносы строк LF;
- финальная пустая строка в файле;
- пробелы вместо табов;
- базовый отступ 2 пробела;
- для Markdown разрешены пробелы в конце строк, если они нужны для форматирования.
Что соблюдать при правках
- Не смешивать табы и пробелы.
- Не менять кодировку файлов.
- Не убирать финальную пустую строку.
- Не форматировать весь файл без необходимости.
- Перед большой правкой сначала получить актуальный SHA файла.
- Для Markdown сохранять читаемую структуру заголовков и списков.
Что проверять после правок
- Страница открывается на GitHub Pages.
- Jekyll не падает на YAML/front matter.
- В HTML нет незакрытых тегов.
- В JS нет синтаксических ошибок.
- В CSS нет случайных дублей, которые ломают адаптив.