41 lines
1.8 KiB
Markdown
41 lines
1.8 KiB
Markdown
# Правила проекта
|
|
|
|
## Общие
|
|
|
|
Перед каждым изменением любого файла читай его.
|
|
|
|
После каждого изменения в коде обновляй документацию в README.md, AGENTS.md и директории docs/.
|
|
|
|
## Документация
|
|
|
|
Читай её перед началом работы.
|
|
|
|
Обновляй её после изменений в проекте.
|
|
|
|
README.md — обзор проекта: возможности, карта документов, быстрый старт, лицензия, предостережение.
|
|
|
|
Тематические документы лежат в docs/:
|
|
* install.md - установка
|
|
* color-modes.md - режимы
|
|
* cli/ - команды (обзор и карта файлов — в cli/README.md)
|
|
* extending.md - расширение
|
|
* protocol.md - протокол
|
|
* scripts.md - скрипты
|
|
* raw-data.md - дампы
|
|
|
|
Пользовательские вопросы — в тематических документах, реверс-инжиниринг — в protocol.md.
|
|
|
|
Ссылки между документами — относительные, без якорей на заголовки с кириллицей.
|
|
|
|
## Markdown
|
|
|
|
Каждое предложение должно начинаться с новой строки.
|
|
|
|
Обращайся к читателю на "вы", с маленькой буквы (кроме начала предложения).
|
|
|
|
## Python
|
|
|
|
Код должен быть читаем человеком, простым и хорошо прокомментированным на русском языке.
|
|
|
|
Исполняемые скрипты должны быть с разрешённым `+x`.
|