Как устроен сборник рецептов

Урок 1 из 148 курса «Mistral AI Cookbook»: официальный курс Mistral AI Cookbook (Мистраль) на русском языке. Этот урок бесплатный.

Руководство по участию

Благодарим вас за интерес к участию в этом проекте! Пожалуйста, следуйте приведенным ниже рекомендациям, чтобы обеспечить беспрепятственный процесс внесения вклада.

🔒 Требования безопасности

В этом репозитории предусмотрены проверки безопасности для предотвращения случайных коммитов приватных ключей и конфиденциальной информации.

Необходимая настройка

Перед выполнением любых коммитов вы обязательно должны установить pre-commit хуки:

# Установка pre-commit
pip install pre-commit

# Установка хуков для этого репозитория
pre-commit install

Что произойдет, если вы этого не сделаете?

  • Ваши коммиты будут заблокированы локально, если они содержат приватные ключи
  • PR с приватными ключами **не пройдут проверки CI** и не смогут быть объединены
  • Это защищает всех от случайного раскрытия конфиденциальной информации

🚀 Начало работы

  1. Форкните репозиторий

  2. Клонируйте ваш форк

    git clone https://github.com/<YOUR-USERNAME>/cookbook.git
cd cookbook

  3. Настройте pre-commit хуки (обязательно!)

    pip install pre-commit
pre-commit install

  4. Создайте новую ветку

    git checkout -b <YOUR BRANCH NAME>

  5. Внесите свои изменения

  6. Протестируйте свои изменения

    # Запустите проверку безопасности вручную (необязательно)
pre-commit run detect-private-key --all-files

  7. Закоммитьте и отправьте

    git add .
git commit -m "Your commit message"
git push origin <YOUR BRANCH NAME>

  8. Создайте Pull Request

⚠️ Часто встречающиеся проблемы

Ошибка "Обнаружен приватный ключ"

Если вы видите эту ошибку при коммите:

detect-private-key...........................................................Failed
  • Удалите любые приватные ключи, API ключи или конфиденциальную информацию из ваших файлов
  • Проверьте такие файлы, как .env, файлы конфигурации или любые файлы, содержащие учетные данные
  • Вместо этого используйте переменные окружения или безопасные хранилища для конфиденциальных данных

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

  • Никогда не коммитьте приватные ключи, API ключи, пароли или другую конфиденциальную информацию
  • Используйте переменные окружения для конфигурации
  • Храните конфиденциальные данные в файлах .env и добавляйте их в .gitignore
  • Тестируйте свои изменения локально перед созданием PR

Полезные гиды