Skip to content

CONTRIBUTING-RU.md

Latest commit

 

History

History
97 lines (75 loc) · 4.42 KB

CONTRIBUTING-RU.md

File metadata and controls

97 lines (75 loc) · 4.42 KB
Raw

Руководство для контрибьюторов

Спасибо за интерес к проекту Hercules! Этот документ описывает, как развернуть окружение, оформить изменения и отправить их в проект.

📋 Содержание

Кодекс поведения

Участвуя в проекте, вы соглашаетесь соблюдать Кодекс поведения.

Настройка окружения

Требования

  • .NET 10 SDK
  • Node.js 20+ (для фронтенда hercules-web)
  • (опционально) Ollama для локального инференса

Первый запуск

git clone https://github.com/<owner>/hercules.git
cd hercules

# Бэкенд
dotnet restore
dotnet build Hercules.slnx

# Фронтенд
cd hercules-web && npm install && cd ..

Подробнее: docs/QUICKSTART.md.

Структура веток

  • main — стабильная ветка, всегда собирается.
  • feature/<краткое-имя> — новая функциональность.
  • fix/<краткое-имя> — исправление ошибки.
  • docs/<краткое-имя> — изменения документации.

Ветки создавайте от актуального main.

Соглашения о коммитах

Используем Conventional Commits:

<тип>(<область>): <краткое описание>

[тело — по желанию]

Типы: feat, fix, docs, refactor, test, chore, perf, build, ci.

Примеры:

feat(llm): добавить поддержку streaming-ответов для Ollama
fix(memory): корректно экранировать кириллицу в user_profile.md
docs(api): описать эндпоинт /api/skills/{id}/improve

Стиль кода

C#

  • Следуйте правилам из .editorconfig.
  • nullable включён — избегайте подавления предупреждений без причины.
  • Комментарии и сообщения для пользователя — на русском языке.
  • Имена типов/методов — PascalCase, локальные переменные/параметры — camelCase.
  • Перед PR прогоните: 
    dotnet build Hercules.slnx -warnaserror
dotnet format Hercules.slnx --verify-no-changes

TypeScript / Astro

  • Типизируйте обращения к API через src/lib/api.ts.
  • Используйте утилитарные классы TailwindCSS, избегайте инлайн-стилей.

Процесс Pull Request

  1. Создайте ветку от main.
  2. Внесите изменения и убедитесь, что проект собирается без ошибок и предупреждений.
  3. Обновите документацию (README.md / docs/) при изменении поведения.
  4. Оформите PR по шаблону, опишите мотивацию и способ проверки.
  5. Дождитесь прохождения CI и ревью.

Сообщение об ошибках

Открывайте Issue по соответствующему шаблону. Указывайте:

  • версию .NET (dotnet --version) и ОС;
  • активный LLM-провайдер;
  • шаги воспроизведения и ожидаемое/фактическое поведение;
  • логи или скриншоты при наличии.

Уязвимости безопасности — см. SECURITY.md (не открывайте публичные Issue).