Rules

Что такое Rules

Rules — это механизм настройки поведения GigaCode, позволяющий задавать инструкции, стандарты и ограничения, которые агент должен учитывать при работе с проектом. В отличие от промптов и скиллов, rules применяются автоматически и учитываются как во всех взаимодействиях агента, так и отдельно под проект.

Для чего нужны Rules

Правила/Rules позволяют:

  • задавать стандарты разработки;
  • определять архитектурные ограничения;
  • фиксировать требования к качеству кода;
  • описывать правила тестирования;
  • устанавливать требования к документации;
  • адаптировать поведение агента под процессы внутри команды.

Как создать Rule

Основная папка с настройками это .gigacode_vsc, но мы также частично поддерживаем .gigacode для rule

Шаг 1. Откройте настройки Rules

Откройте настройки GigaCode и перейдите в раздел Rules. В этом разделе можно просматривать и отключать пользовательские правила.

Шаг 2. Создайте новое правило

Перейдите в папку проекта .gigacode на своем устройстве и создайте в ней новую папку rules. В новой папке rules создайте новый файл в формате markdown.

Для формирования нового правила необходимо придерживаться четкой структуры в .md формате.

Укажите:

  • название правила;
  • описание.

Шаг 3. Опишите правило

Формулируйте навык как конкретную инструкцию для агента.

# Правила проекта 

## Архитектура

- Используй слоистую архитектуру: controller, service, repository, domain. 
- Бизнес-логика должна находиться в service-слое. 
- Controller не должен напрямую обращаться к repository. 

## Тестирование 

- Для всех новых публичных методов создавай unit-тесты. 
- Для API-изменений добавляй интеграционные тесты. 
- Используй существующий стиль тестов проекта. 

## Безопасность 

- Не читай и не изменяй файлы .env, credentials.json, secrets.yaml. 
- Не выводи секреты и токены в ответах. 
- При изменении авторизации указывай возможные риски.

Вид графа