From 965235e390dcb9b515566c167d5532346d140264 Mon Sep 17 00:00:00 2001 From: "S.Gromov" Date: Wed, 1 Apr 2026 10:45:22 +0300 Subject: [PATCH] =?UTF-8?q?docs:=20=D1=83=D0=B1=D1=80=D0=B0=D1=82=D1=8C=20?= =?UTF-8?q?Workflow=20=D0=B8=20=D0=A7=D0=B5=D0=BA=D0=BB=D0=B8=D1=81=D1=82?= =?UTF-8?q?=20=D0=B8=D0=B7=20=D1=81=D1=82=D1=80=D1=83=D0=BA=D1=82=D1=83?= =?UTF-8?q?=D1=80=D1=8B=20=D0=BF=D1=80=D0=B8=D0=BA=D0=BB=D0=B0=D0=B4=D0=BD?= =?UTF-8?q?=D0=BE=D0=B3=D0=BE=20=D1=80=D0=B0=D0=B7=D0=B4=D0=B5=D0=BB=D0=B0?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - удалены секции «Workflow» и «Чеклист» из шаблона - обновлено описание раздела: о чём раздел и какие аспекты он охватывает - обновлён порядок секций: убраны «процесс» и «проверка» - удалён принцип «Workflow vs правила», нумерация сдвинута --- CONTRIBUTING.md | 26 +++++--------------------- 1 file changed, 5 insertions(+), 21 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index fda91df..136381d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -91,7 +91,7 @@ concat-md.js # Скрипт генерации RULES.md ```markdown # {Название} -Одно-два предложения: что это за область, зачем она нужна. +Краткое описание: о чём раздел и какие аспекты работы с областью он охватывает. ## Что нужно знать @@ -145,28 +145,13 @@ concat-md.js # Скрипт генерации RULES.md Полноценные примеры кода. Каждый пример с путём к файлу и пояснениями. -## Workflow (процессы) - -Пошаговая инструкция: как работать с этой областью на практике. -Отвечает на вопрос: «Что делать и в каком порядке?» -Нумерованный список шагов. Минимум кода — только команды и имена файлов. -Не дублирует правила — описывает процесс, а не результат. -Если для области нет специфичного процесса — секция не создаётся. - -## Чеклист - -Контрольный список для проверки перед завершением работы. -Отвечает на вопрос: «Всё ли я сделал правильно?» -Формат — маркированный список с чекбоксами (`- [ ]`). -Каждый пункт — конкретная проверка, а не пересказ правила. -Если для области нет специфичных проверок — секция не создаётся. ``` ### Порядок секций -Порядок фиксированный: контекст → структура → правила → специализации базовых правил → примеры → процесс → проверка. +Порядок фиксированный: контекст → структура → правила → специализации базовых правил → примеры. -Логика: читатель сначала понимает «что это», потом «где это лежит», потом «как это делать», видит полный пример, получает пошаговую инструкцию и в конце проверяет себя по чеклисту. +Логика: читатель сначала понимает «что это», потом «где это лежит», потом «как это делать», и в конце видит полный пример. ### Секции-расширения базовых правил @@ -238,6 +223,5 @@ title: Название раздела 1. **Не дублировать.** Одна мысль живёт в одном месте. Остальные ссылаются. 2. **Базовое vs прикладное.** Если правило применимо ко всему коду — оно базовое. Если только к одной области — прикладное. -3. **Workflow vs правила.** Workflow описывает процесс (шаги), правила описывают результат (каким должен быть код). Оба живут внутри прикладного раздела, но не смешиваются. -4. **Пустые секции не создавать.** Если для раздела нет специфики по именованию — секции «Именование» в нём нет. -5. **Примеры обязательны.** Прикладной раздел без примеров кода — незавершён. +3. **Пустые секции не создавать.** Если для раздела нет специфики по именованию — секции «Именование» в нём нет. +4. **Примеры обязательны.** Прикладной раздел без примеров кода — незавершён.