docs/nextjs-style-guide
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: убрать Workflow и Чеклист из структуры прикладного раздела

Browse Source 
- удалены секции «Workflow» и «Чеклист» из шаблона
- обновлено описание раздела: о чём раздел и какие аспекты он охватывает
- обновлён порядок секций: убраны «процесс» и «проверка»
- удалён принцип «Workflow vs правила», нумерация сдвинута
This commit is contained in:
Сергей Громов
2026-04-01 10:45:22 +03:00
parent e608017dce
commit 965235e390
1 changed files with 5 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
CONTRIBUTING.md
View File

@@ -91,7 +91,7 @@ concat-md.js # Скрипт генерации RULES.md
```markdown ```markdown
# {Название} # {Название}
Одно-два предложения: что это за область, зачем она нужна. Краткое описание: о чём раздел и какие аспекты работы с областью он охватывает.
## Что нужно знать ## Что нужно знать
@@ -145,28 +145,13 @@ concat-md.js # Скрипт генерации RULES.md
Полноценные примеры кода. Полноценные примеры кода.
Каждый пример с путём к файлу и пояснениями. Каждый пример с путём к файлу и пояснениями.
## Workflow (процессы)
Пошаговая инструкция: как работать с этой областью на практике.
Отвечает на вопрос: «Что делать и в каком порядке?»
Нумерованный список шагов. Минимум кода — только команды и имена файлов.
Не дублирует правила — описывает процесс, а не результат.
Если для области нет специфичного процесса — секция не создаётся.
## Чеклист
Контрольный список для проверки перед завершением работы.
Отвечает на вопрос: «Всё ли я сделал правильно?»
Формат — маркированный список с чекбоксами (`- [ ]`).
Каждый пункт — конкретная проверка, а не пересказ правила.
Если для области нет специфичных проверок — секция не создаётся.
``` ```
### Порядок секций ### Порядок секций
Порядок фиксированный: контекст → структура → правила → специализации базовых правил → примеры → процесс → проверка. Порядок фиксированный: контекст → структура → правила → специализации базовых правил → примеры.
Логика: читатель сначала понимает «что это», потом «где это лежит», потом «как это делать», видит полный пример, получает пошаговую инструкцию и в конце проверяет себя по чеклисту. Логика: читатель сначала понимает «что это», потом «где это лежит», потом «как это делать», и в конце видит полный пример.
### Секции-расширения базовых правил ### Секции-расширения базовых правил
@@ -238,6 +223,5 @@ title: Название раздела
1. **Не дублировать.** Одна мысль живёт в одном месте. Остальные ссылаются. 1. **Не дублировать.** Одна мысль живёт в одном месте. Остальные ссылаются.
2. **Базовое vs прикладное.** Если правило применимо ко всему коду — оно базовое. Если только к одной области — прикладное. 2. **Базовое vs прикладное.** Если правило применимо ко всему коду — оно базовое. Если только к одной области — прикладное.
3. **Workflow vs правила.** Workflow описывает процесс (шаги), правила описывают результат (каким должен быть код). Оба живут внутри прикладного раздела, но не смешиваются. 3. **Пустые секции не создавать.** Если для раздела нет специфики по именованию — секции «Именование» в нём нет.
4. **Пустые секции не создавать.** Если для раздела нет специфики по именованию — секции «Именование» в нём нет. 4. **Примеры обязательны.** Прикладной раздел без примеров кода — незавершён.
5. **Примеры обязательны.** Прикладной раздел без примеров кода — незавершён.