Что писать

  • О проекте: что это и для кого, в одном-двух предложениях.
  • Как запускать: команды сборки и проверки.
  • Стиль: язык текстов, шрифты, цвета, правила оформления кода.
  • Запреты: что не трогать, куда не лезть без вопроса.
  • Где что лежит: папки с данными и шаблонами.

Пример

# Сайт kapnin.tech
Статический сайт, собирается командой `python3 build.py` в папку dist.

## Правила
- Тексты на русском, без канцелярита.
- Не добавлять внешние библиотеки.
- Новый гайд — это запись в content/guides_data.py.
- После правок запускать сборку и проверять, что она проходит.

Как сделать, чтобы агент слушался

  1. Пиши коротко и конкретно. Длинный файл агент учитывает хуже.
  2. Формулируй проверяемо: «не добавлять библиотеки», а не «делай аккуратно».
  3. Исправляй файл, когда замечаешь, что агент повторяет ошибку: правило записывается один раз.
  4. Не храни в файле секреты.

Если используешь и Claude, и Codex

Держи правила в одном файле и сделай второй короткой ссылкой на него, чтобы не поддерживать две копии. Подробнее о том, как выбрать между агентами.

Частые вопросы

Где должен лежать файл?

В корне проекта. Некоторые агенты читают также файлы во вложенных папках для правил, действующих только там.