Перейти к основному содержимому

Как внести вклад в проект

Мы рады приветствовать новых контрибьюторов в нашем проекте! Этот документ поможет вам разобраться, как внести свой вклад в развитие проекта Learn Agents - интерактивной книги об AI Агентах.

Что такое контрибьютинг?​

Контрибьютинг - это процесс внесения вклада в открытый проект. Вклад может быть разным:

  • Исправление ошибок в контенте
  • Добавление нового материала
  • Улучшение документации
  • Перевод контента
  • Разработка новых компонентов
  • Улучшение UI/UX

Как начать​

  1. Форкните репозиторий
    Создайте форк нашего основного репозитория:

  2. Клонируйте репозиторий

    git clone https://github.com/ваш-username/learn-agents.git
    cd learn-agents

  3. Установите зависимости

    npm install

  4. Запустите локальную версию

    npx docusaurus start --locale ru

Создание контента​

Структура проекта​

Контент размещается в следующих директориях:

  • Английская версия: /docs/
  • Русская версия: /i18n/ru/docusaurus-plugin-content-docs/current/

Форматирование​

  • Используйте Markdown для базового форматирования
  • Для более сложных компонентов используйте MDX
  • Изображения храните в /static/img/

Пример добавления нового материала​

  1. Создайте новый файл .mdx в соответствующей директории
  2. Добавьте метаданные в начало файла: 
    ---
    sidebar_label: Название для боковой панели
    ---

    # Заголовок страницы
  3. Напишите и отформатируйте ваш контент

Добавление страницы в навигацию​

Чтобы ваша новая страница отображалась в боковой панели навигации, необходимо добавить её в файл sidebars.ts в корне проекта:

  1. Откройте файл sidebars.ts
  2. Найдите соответствующую категорию для вашей страницы
  3. Добавьте путь к вашему файлу в соответствующий раздел:
// Пример добавления новой страницы в категорию Handbook
{
  type: 'category',
  label: 'Handbook',
  items: [
    'handbook/introduction',
    'handbook/contributing', // существующие страницы
    'handbook/ваша-новая-страница', // ваша новая страница
  ],
},

Обратите внимание, что путь указывается без расширения .mdx и относительно директории docs/ или i18n/ru/docusaurus-plugin-content-docs/current/.

Правила оформления кода​

  • Пишите компоненты на английском языке
  • Используйте TypeScript для типизации
  • Следуйте стилю кода, используемому в проекте

Отправка изменений​

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

    git checkout -b название-вашей-ветки

  2. Внесите и закоммитьте изменения

    git add .
    git commit -m "Описание ваших изменений"

  3. Отправьте изменения в ваш форк

    git push origin название-вашей-ветки

  4. Создайте Pull Request
    Перейдите на GitHub и создайте PR из вашей ветки в основной репозиторий.

Процесс ревью​

После создания Pull Request ваши изменения будут рассмотрены командой проекта. Мы можем попросить внести некоторые корректировки. После успешного ревью ваши изменения будут приняты в проект.

Правила сообщества​

  • Уважайте других участников
  • Следуйте Code of Conduct
  • Обсуждайте крупные изменения перед их реализацией
  • В случае вопросов, обращайтесь к нам:

Благодарность​

Большое спасибо за ваш вклад в проект! Вместе мы делаем знания об AI Агентах доступнее для всех.

Comments