Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
279 lines (206 loc) · 9.77 KB

CONTRIBUTING.md

File metadata and controls

279 lines (206 loc) · 9.77 KB

Contributing to AI Development Partner

Спасибо за интерес к проекту! Мы приветствуем любые вклады - от исправления опечаток до добавления новых функций.

Как внести вклад

Сообщить об ошибке

Нашли ошибку или проблему? Создайте Issue с описанием:

  • Что произошло
  • Что вы ожидали
  • Шаги для воспроизведения
  • Версия промпта и платформа (Claude, ChatGPT, локальная LLM)

Шаблон Issue:

## Описание проблемы
[Краткое описание]

## Шаги для воспроизведения
1. ...
2. ...

## Ожидаемое поведение
[Что должно было произойти]

## Фактическое поведение
[Что произошло]

## Окружение
- Платформа: Claude / ChatGPT / Ollama / Open WebUI
- Версия промпта: Full / Mini / Universal
- Модель: Claude Opus / GPT-4 / Llama 3 70B

Предложить улучшение

Есть идея для улучшения? Создайте Discussion или Issue с тегом enhancement.

Что включить:

  • Описание проблемы, которую решает предложение
  • Предлагаемое решение
  • Альтернативные варианты (если есть)
  • Примеры использования

Внести изменения в код/документацию

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

    git clone https://github.com/YOUR_USERNAME/ai-development-partner.git
cd ai-development-partner

  2. Создайте ветку для ваших изменений

    git checkout -b feature/your-feature-name
# или
git checkout -b fix/bug-description

  3. Внесите изменения

    Следуйте правилам оформления

  4. Закоммитьте изменения

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

    git commit -m "feat: add support for Grok integration"
git commit -m "fix: correct typo in INTEGRATION_GUIDE.md"
git commit -m "docs: improve examples for Node.js projects"

    Типы коммитов:

    • feat: - новая функциональность
    • fix: - исправление ошибки
    • docs: - изменения в документации
    • refactor: - рефакторинг кода
    • test: - добавление тестов
    • chore: - обновление зависимостей, конфигурации

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

    git push origin feature/your-feature-name

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

    Перейдите в оригинальный репозиторий и нажмите New Pull Request.

    Шаблон PR:

    ## Описание изменений
[Что было изменено и почему]

## Тип изменений
- [ ] Bug fix (исправление ошибки)
- [ ] New feature (новая функциональность)
- [ ] Documentation (документация)
- [ ] Refactoring (рефакторинг)

## Checklist
- [ ] Код следует style guide проекта
- [ ] Документация обновлена (если нужно)
- [ ] Примеры работают (если добавлены новые)
- [ ] CHANGELOG.md обновлён

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

Структура файлов

.
├── prompts/              # Системные промпты
│   ├── system_prompt_full.md
│   ├── system_prompt_mini.md
│   └── system_prompt_universal.md
├── templates/            # Шаблоны для интеграции
│   ├── claude/
│   ├── chatgpt/
│   ├── local-llm/
│   └── vscode/
├── examples/             # Примеры использования
│   ├── laravel/
│   ├── nodejs/
│   └── python/
└── docs/                 # Документация
    ├── INTEGRATION_GUIDE.md
    ├── SETUP.md
    └── FAQ.md

Промпты (prompts/)

При изменении промптов:

  1. Сохраняйте структуру:

    • Не меняйте порядок секций без необходимости
    • Используйте существующие заголовки и форматирование

  2. Тестируйте изменения:

    • Проверьте на Claude, ChatGPT и локальной LLM
    • Убедитесь, что команды работают

  3. Обновляйте версию:

    • Увеличьте номер версии в конце файла
    • Добавьте запись в CHANGELOG.md

  4. Документируйте изменения:

    • Опишите, что изменилось
    • Объясните, почему это улучшение

Документация (docs/, templates/, examples/)

  1. Markdown форматирование:

    • Используйте заголовки правильного уровня
    • Добавляйте примеры кода с подсветкой синтаксиса
    • Используйте списки для структурирования

  2. Примеры кода:

    \`\`\`php
// Хороший пример с комментариями
$result = Product::with('category')->get();
\`\`\`

  3. Ссылки:

    • Используйте относительные пути для внутренних ссылок
    • Проверяйте, что ссылки работают

  4. Скриншоты/диаграммы:

    • Размещайте в docs/assets/
    • Используйте Mermaid для диаграмм

Примеры использования (examples/)

При добавлении новых примеров:

  1. Структура:

    examples/[tech-stack]/
├── README.md           # Основной гайд
├── scenario-1.md       # Отдельные сценарии
└── config/             # Примеры конфигов

  2. Содержание README.md:

    • Описание стека
    • Настройка промпта под стек
    • 3-5 практических примеров
    • Tips & Best Practices

  3. Реалистичность:

    • Примеры должны быть реальными и практичными
    • Покрывайте типичные кейсы использования

Что мы ищем

Приоритетные вклады:

  1. Новые интеграции:

    • Поддержка новых LLM платформ
    • Интеграция с IDE и редакторами
    • Шаблоны для новых стеков (Ruby, Rust, Elixir и т.д.)

  2. Улучшение промптов:

    • Новые полезные команды
    • Оптимизация существующих
    • Специализированные версии (для DevOps, Data Science и т.д.)

  3. Документация:

    • Переводы на другие языки
    • Видео-туториалы
    • Подробные гайды по интеграции

  4. Примеры:

    • Реальные кейсы использования
    • Примеры для разных tech stacks
    • Best practices

Не принимаем:

  • Коммерческую рекламу
  • Изменения, нарушающие обратную совместимость без веской причины
  • Код без документации
  • Копипаст из других проектов без указания источника

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

  1. Автоматические проверки:

    • Markdown lint (проверка форматирования)
    • Spell check (проверка орфографии)

  2. Code review:

    • Один из мейнтейнеров проверит ваш PR
    • Могут быть запрошены изменения
    • Обсуждение ведется в комментариях к PR

  3. Мерж:

    • После одобрения PR будет смержен
    • Ваш вклад появится в следующем релизе
    • Вы будете добавлены в список контрибьюторов

Сообщество

  • GitHub Discussions: Для вопросов и обсуждений
  • GitHub Issues: Для багов и feature requests
  • Twitter: @ShaerWare - новости проекта

Лицензия

Внося вклад в проект, вы соглашаетесь, что ваш код будет лицензирован под MIT License.

Благодарности

Спасибо всем, кто вносит вклад в проект! 🙏

Особая благодарность:

Есть вопросы? Создайте Discussion или напишите в Issues!