Перейти к содержанию

Лучшие практики

1. Именование навыков

Хорошо:

  • react-component
  • python-api
  • db-migration
  • git-commit-message

Плохо:

  • React Component (пробелы)
  • mySkill123 (непонятно)

2. Описание навыка

Хорошо:

description: Создание REST API на Python с FastAPI. 
             Используй когда пользователь просит создать endpoint, 
             API, или упоминает FastAPI.

Плохо:

description: создание API  # Слишком кратко

3. Структура инструкций

Хорошо:

## Instructions

### 1. Подготовка
Описание шага 1

### 2. Реализация
Описание шага 2

### 3. Тестирование
Описание шага 3

Плохо:

## Instructions
Делай хорошо, плохо не делай

4. Примеры кода

Хорошо:

// Полный рабочий пример
export const Component: FC<Props> = ({ prop }) => {
  return <div>{prop}</div>;
};

Плохо:

// Неполный пример
const Comp = (props) => {
  // ...
};

5. Поддержание навыков

  • Регулярно обновляйте — актуализируйте инструкции
  • Тестируйте — проверяйте, что навыки работают
  • Документируйте изменения — ведите changelog
  • Собирайте фидбек — от команды и модели