Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
141 lines (92 loc) · 10.3 KB

CONTRIBUTING.md

File metadata and controls

141 lines (92 loc) · 10.3 KB

Вклад в Roo Code

Roo Code — это проект, управляемый сообществом, и мы глубоко ценим каждый вклад. Чтобы упростить совместную работу, мы работаем на основе подхода «сначала задача», что означает, что все запросы на слияние (PR) должны быть сначала связаны с задачей на GitHub. Пожалуйста, внимательно ознакомьтесь с этим руководством.

Оглавление

Прежде чем вы начнете вносить свой вклад

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

Все участники должны придерживаться нашего Кодекса поведения.

2. Дорожная карта проекта

Наша дорожная карта определяет направление развития проекта. Согласуйте свои вклады с этими ключевыми целями:

Надежность прежде всего

  • Обеспечьте постоянную надежность редактирования различий и выполнения команд.
  • Уменьшите количество проблемных моментов, которые отбивают желание регулярного использования.
  • Гарантируйте бесперебойную работу во всех локалях и на всех платформах.
  • Расширьте надежную поддержку для широкого спектра поставщиков и моделей ИИ.

Улучшенный пользовательский опыт

  • Оптимизируйте пользовательский интерфейс/опыт для ясности и интуитивности.
  • Постоянно улучшайте рабочий процесс, чтобы соответствовать высоким ожиданиям, которые разработчики предъявляют к инструментам повседневного использования.

Лидерство в производительности агентов

  • Создайте комплексные оценочные тесты (evals) для измерения реальной производительности.
  • Сделайте так, чтобы каждый мог легко запускать и интерпретировать эти оценки.
  • Поставляйте улучшения, которые демонстрируют явное увеличение оценочных баллов.

Упоминайте о соответствии этим областям в своих PR.

3. Присоединяйтесь к сообществу Roo Code

  • Основной: Присоединяйтесь к нашему Discord и напишите личное сообщение Hannes Rudolph (hrudolph).
  • Альтернатива: Опытные участники mogą напрямую взаимодействовать через Проекты GitHub.

Поиск и планирование вашего вклада

Типы вкладов

  • Исправления ошибок: решение проблем с кодом.
  • Новые функции: добавление функциональности.
  • Документация: улучшение руководств и ясности.

Подход «сначала задача»

Все вклады начинаются с задачи на GitHub с использованием наших простых шаблонов.

  • Проверьте существующие задачи: выполните поиск в задачах GitHub.
  • Создайте задачу, используя:
    • Улучшения: шаблон «Запрос на улучшение» (простой язык, ориентированный на пользу для пользователя).
    • Ошибки: шаблон «Отчет об ошибке» (минимальное воспроизведение + ожидаемый и фактический результат + версия).
  • Хотите над этим поработать? Напишите комментарий «Забираю» к задаче и напишите личное сообщение Hannes Rudolph (hrudolph) в Discord, чтобы вас назначили. Назначение будет подтверждено в ветке.
  • PR должны ссылаться на задачу. Несвязанные PR могут быть закрыты.

Решение, над чем работать

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

  • Сначала проверьте существующие отчеты.
  • Создайте новую ошибку, используя шаблон «Отчет об ошибке» с:
    • Четкими, пронумерованными шагами воспроизведения
    • Ожидаемым и фактическим результатом
    • Версией Roo Code (обязательно); поставщиком/моделью ИИ, если применимо
  • Проблемы с безопасностью: сообщайте в частном порядке через рекомендации по безопасности.

Процесс разработки и подачи

Настройка разработки

  1. Сделайте форк и клонируйте:
git clone https://github.com/ВАШЕ_ИМЯ_ПОЛЬЗОВАТЕЛЯ/Roo-Code.git
  1. Установите зависимости:
pnpm install
  1. Отладка: откройте в VS Code (F5).

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

  • Один сфокусированный PR на функцию или исправление.
  • Следуйте лучшим практикам ESLint и TypeScript.
  • Пишите четкие, описательные коммиты со ссылкой на задачи (например, Исправляет #123).
  • Предоставляйте тщательное тестирование (npm test).
  • Перед отправкой выполните rebase на последнюю ветку main.

Подача запроса на слияние

  • Начните с черновика PR, если вам нужна ранняя обратная связь.
  • Четко опишите свои изменения, следуя шаблону запроса на слияние.
  • Ссылайтесь на задачу в описании/названии PR (например, «Исправляет #123»).
  • Предоставьте скриншоты/видео для изменений в пользовательском интерфейсе.
  • Укажите, необходимы ли обновления документации.

Политика запросов на слияние

  • Должен ссылаться на назначенную задачу GitHub. Чтобы вас назначили: напишите комментарий «Забираю» к задаче и напишите личное сообщение Hannes Rudolph (hrudolph) в Discord. Назначение будет подтверждено в ветке.
  • Несвязанные PR могут быть закрыты.
  • PR должны проходить тесты CI, соответствовать дорожной карте и иметь четкую документацию.

Процесс проверки

  • Ежедневная сортировка: быстрая проверка сопровождающими.
  • Еженедельный углубленный обзор: всесторонняя оценка.
  • Быстро итерируйте на основе обратной связи.

Юридические вопросы

Внося свой вклад, вы соглашаетесь с тем, что ваши вклады будут лицензироваться по лицензии Apache 2.0, в соответствии с лицензированием Roo Code.