Руководство по стилю Copilot
Это руководство предоставляет обзор файла Copilot dbt-styleguide.md, описывая его структуру, рекомендуемое использование и лучшие практики для эффективного применения в ваших проектах dbt.
dbt-styleguide.md — это шаблон для создания руководства по стилю для проектов dbt. Он включает в себя:
- Рекомендации по стилю SQL (например, использование ключевых слов в нижнем регистре и завершающих запятых)
- Организацию моделей и соглашения об именовании
- Конфигурации моделей и практики тестирования
- Рекомендации по использованию pre-commit hooks для принудительного соблюдения правил стиля
Это руководство помогает обеспечить согласованность и понятность в проектах dbt.
dbt-styleguide.md для Copilot
Используя Copilot в Studio IDE, вы можете автоматически сгенерировать шаблон руководства по стилю с именем dbt-styleguide.md. Если руководство по стилю добавляется или редактируется вручную, оно также должно следовать этому соглашению об именовании. Любое другое имя файла не может быть использовано с Copilot.
Добавьте файл dbt-styleguide.md в корень вашего проекта. Copilot будет использовать его как контекст для большой языковой модели (LLM) при генерации data tests, metrics, semantic models и documentation.
Обратите внимание: создавая dbt-styleguide.md для Copilot, вы переопределяете руководство по стилю dbt по умолчанию.
Создание dbt-styleguide.md в Studio IDE
- Откройте файл в Studio IDE.
- Нажмите Copilot на панели инструментов.
- Выберите Generate ... Style guide в меню.
Генерация руководства по стилю в Copilot- Шаблон руководства по стилю появится в Studio IDE. Нажмите Save.
Файлdbt-styleguide.mdбудет добавлен на корневом уровне вашего проекта.
Если вы ранее не генерировали файл руководства по стилю, последняя версия будет автоматически получена из dbt platform.
Если dbt-styleguide.md уже существует
Если файл dbt-styleguide.md уже существует и вы попытаетесь сгенерировать новое руководство по стилю, появится модальное окно со следующими вариантами:
- Cancel — Выйти без внесения изменений.
- Restore — Вернуться к последней версии из dbt platform.
- Edit — Вручную изменить существующее руководство по стилю.
Руководство по стилю уже существует