Skip to content

English | Русский

Начните здесь: вы меняете сам TAUSIK ​

Вы правите фреймворк, а не пользуетесь им: гейт, хук, генератор, документ, от которого зависят другие документы. Эта страница — порядок чтения для этого, и единственная привычка, о которой она просит, — собственная привычка проекта: правило, о котором только просят, выключают в ту же неделю, поэтому всё, что вы добавляете, приходит вместе с механизмом, который это держит.

Порядок ​

  1. architecture.md — слои и кто кого вправе импортировать. Правка, пересекающая слой, — проектное решение, а не рефакторинг.
  2. testing-principles.md — суженный pytest, что заслуживает теста и анти-паттерны, за которые проект уже заплатил.
  3. hooks.md и enforcement-coverage.md — где живёт принуждение и где именно оно заканчивается.
  4. dev-doc-checks.md — аудиты, читающие дерево: файлы-сироты, протухшие документы, неиспользуемый Python, дублирующиеся формы тестов.
  5. i18n-strategy.md — обе языковые половины суть один документ. Односторонняя страница обязана машиночитаемо объявить причину, иначе проверка паритета краснеет.

Прежде чем добавить правило ​

  • Кладите его туда, где его прочтут. Реестр, стоящий в стороне от предмета, носит отписку, которую никто не перечитывает: список singletons в этом репозитории объяснял отсутствие английского контракта причиной, которая была ложной годами.
  • Давайте ему храповик, а не абзац. Пороги лежат в tausik/gates.json; тест их читает и отказывает росту. Порог снимайте ПОСЛЕ уборки — по числам до неё храповик закрепит мусор.
  • Не оставляйте его в деселектированной ленте. addopts несёт -m 'not slow', поэтому сторож с этой меткой держит свой ноль только в той ленте, которую никто не запускает по привычке.
  • Называйте слепое пятно. Если новая проверка чего-то не видит, скажите это в её докстринге и в known-limitations.md. Сторож, чьё слепое пятно не объявлено, читается как полный.

Добавление страницы ​

Объявите читателя и зону в самой странице (<!-- doc-map: reader=…; zone=… -->), напишите обе языковые половины и перевыпустите карту командой python scripts/doc_map.py --write. Страница без объявления — находка, а не умолчание.

Выпуск ​

publishing.md — публичный снимок и что из него отфильтровано, senar-compliance-matrix.md — что заявлено по стандарту, а что лишь реализовано.