mirror of
https://github.com/smmarty/friflex_flutter_starter.git
synced 2026-02-05 03:32:18 +00:00
33 lines
3.0 KiB
Markdown
33 lines
3.0 KiB
Markdown
|
---
|
|||
|
|
name: flutter_dev
|
|||
|
|
description: Скилл для разработки Flutter-приложений по стандартам компании Friflex. Используйте этот скилл при написании кода, создании новых фич, проведении ревью или настройке архитектуры проекта. Включает правила именования, структуру слоев (data/domain/presentation) и стандарты Git.
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
# Flutter Dev Skill (Friflex Standards)
|
|||
|
|
|
|||
|
|
Этот скилл содержит набор правил и инструкций для разработки Flutter-приложений. Основная цель — соблюдение единого стиля кода, архитектурных подходов и процессов разработки.
|
|||
|
|
|
|||
|
|
## Основные принципы
|
|||
|
|
|
|||
|
|
1. **Архитектура**: Проект делится на слои: `data`, `domain` и `presentation`.
|
|||
|
|
2. **Именование**: Интерфейсы всегда начинаются с префикса `I`. Экраны имеют постфикс `Screen`.
|
|||
|
|
3. **Документация**: Весь публичный API должен быть покрыт документацией `///`.
|
|||
|
|
4. **Git**: Коммиты и PR на русском языке по стандарту Conventional Commits.
|
|||
|
|
|
|||
|
|
## Справочники (References)
|
|||
|
|
|
|||
|
|
Для получения детальной информации по конкретным областям обращайтесь к следующим файлам:
|
|||
|
|
|
|||
|
|
- [Правила именования и стиль кода](references/codestyle.md) — именование классов, методов, переменных и структура файлов.
|
|||
|
|
- [Структура проекта и слои](references/project_structure.md) — детальное описание папок и взаимодействия между уровнями архитектуры.
|
|||
|
|
- [Работа с Git и ветками](references/gitflow.md) — типы коммитов, именование веток и процессы релизов.
|
|||
|
|
- [Документирование кода](references/documentation.md) — стандарты `///`, использование шаблонов и правила для TODO.
|
|||
|
|
- [Стандарты проекта](references/project_standards.md) — управление сгенерированными файлами, `pubspec.lock` и сборка.
|
|||
|
|
|
|||
|
|
## Когда использовать этот скилл
|
|||
|
|
|
|||
|
|
- При создании новых классов или файлов (проверка именования).
|
|||
|
|
- При реализации новой feature (выбор структуры папок).
|
|||
|
|
- Перед созданием Pull Request (проверка соответствия стандартам).
|
|||
|
|
- При возникновении вопросов по архитектурному взаимодействию слоев.
|