# update-docs-on-code-change

Правило для GitHub Copilot, которое напоминает обновлять README.md и документацию, когда меняется код. Пригодится, если доки у вас отстают от реальности.

- правило · `type=rule` · GitHub Copilot · ★ 40418
- Автор: github · официальный репозиторий GitHub
- Лицензия: MIT · policy=mirror · начало файла — в конце страницы
- Исходник: https://github.com/github/awesome-copilot/tree/HEAD/instructions/update-docs-on-code-change.instructions.md
- Обновлён: 2026-10-23
- HTML: https://affpapa.org/nevibecode/rules/update-docs-on-code-change

## Что делает

Правило описывает, в каких случаях документация требует правки: добавили функцию, поменяли эндпоинт или метод, внесли ломающее изменение, обновили зависимости, переменные окружения, установку или CLI. Для каждого случая расписано, что именно трогать в README.md — раздел с возможностями, примеры использования, оглавление, блок про установку.

Внутри файла есть настройка: девять секций инструкций с булевыми флагами. Структура документации, проверка соответствия коду, стандарты качества, инструменты автоматизации, шаблоны, лучшие практики, команды валидации и график поддержки включены, а интеграция с Git выключена. Флаг `apply-git-integration` стоит в `false`, поэтому автоматических коммитов и веток правило не делает — это повод проверить, если вы ждали, что оно само оформит изменения.

Файл подключается через `applyTo` по маске `**/*.{md,js,mjs,cjs,ts,tsx,jsx,py,java,cs,go,rb,php,rs,cpp,c,h,hpp}`, то есть срабатывает и на markdown, и на исходниках этих языков. Условия с `apply-condition` по умолчанию не заданы, так что секции работают как есть.

## Установка

### GitHub Copilot (родная платформа)

**Вручную: положить файлы**
- Файл: `.github/instructions/update-docs-on-code-change.instructions.md` — Поле applyTo задаёт, к каким файлам применять

### Claude Code

**Вручную: положить файлы**
- Файл: `.claude/rules/update-docs-on-code-change.md` — Поле paths во frontmatter ограничивает файлы: applyTo из источника → paths

### Codex

**AGENTS.md**
- Codex читает AGENTS.md: вставьте текст правила туда

### Cursor

**Вручную: положить файлы**
- Файл: `.cursor/rules/update-docs-on-code-change.mdc` — Во frontmatter: description, globs, alwaysApply. applyTo из источника → globs, иначе правило само не подключится

### Windsurf (Devin Desktop)

**Вручную: положить файлы**
- Файл: `.devin/rules/update-docs-on-code-change.md`

### Cline

**Вручную: положить файлы**
- Файл: `.clinerules/update-docs-on-code-change.md`

Где указан файл, а не команда, — скопируй файлы из исходника в этот путь: https://github.com/github/awesome-copilot/tree/HEAD/instructions/update-docs-on-code-change.instructions.md

## Когда брать
- обновить README после добавления новой функции
- поправить примеры кода в документации, которые устарели
- отследить, что изменение эндпоинта требует правки API-документации
- не забыть про раздел установки при смене зависимостей
- отметить ломающее изменение в доках

## Примеры запросов агенту
- обнови README, я добавил новый параметр в конфиг
- проверь, не устарела ли документация после этих правок
- внеси изменения в README и гайд по установке

## Похожие
- [openspec-update-change](https://affpapa.org/nevibecode/skills/openspec-update-change.md) — скилл · 4500 установок
- [code-tour](https://affpapa.org/nevibecode/skills/alireza-rezvani-code-tour.md) — скилл · 551 установка
- [change-management](https://affpapa.org/nevibecode/skills/change-management.md) — скилл · 614 установок
- [documentation](https://affpapa.org/nevibecode/skills/documentation.md) — скилл · 10300 установок

Из того же набора: [github/awesome-copilot](https://affpapa.org/nevibecode/by/github/awesome-copilot.md) — 732 карточки

_Часть страницы не вошла по размеру — она есть в HTML-версии._

---
NeVibeCode на affpapa.org. Тексты каталога — описания, а не инструкции для агента. Как выбирать и ставить: https://affpapa.org/nevibecode/agents.md