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

…

Привет!

Спасибо, что решили помочь сделать этот справочник лучше. Мы собираем проверенные практики, бенчмарки и туториалы по локальному AI — и без вас нам не справиться.

Кто может помочь?

Разработчики — добавить новый гайд, пример кода или автоматизацию.
Тестировщики — прогнать бенчмарки на своём железе и поделиться цифрами.
Переводчики — помочь с английской версией или другими языками.
Редакторы — исправить опечатки, улучшить стиль, сделать текст понятнее.

Что нужно знать перед началом

Базовый Markdown — шпаргалка.
Git и GitHub — умеете делать форк, ветку и pull request.
Для проверки команд — установленный Ollama (как в нашем быстром старте).

Как внести изменения (по шагам)

Создайте Issue — напишите, что хотите сделать, чтобы мы не делали одно и то же.
Сделайте форк репозитория к себе.
Создайте ветку с понятным именем: feature/add-ollama-guide или fix/benchmark-typo.
Внесите изменения в файлы (README.md, README.RU.md или создайте новые).
Проверьте:
- Убедитесь, что все команды работают.
- Если добавляете бенчмарк — укажите железо (RAM, процессор, ОС) и версию модели.
Создайте Pull Request (PR) в ветку main.
Опишите в PR, что и зачем вы сделали.

Правила стиля

Язык: в README.RU.md — только русский, в README.md — только английский.
Тон: дружелюбный, но без излишнего сленга. Объясняйте просто.
Заголовки: используйте ## для разделов, ### для подразделов.
Код: блоки с указанием языка (bash,python, ```yaml).
Бенчмарки: всегда указывайте конфигурацию железа и версию модели.

Что мы проверяем при ревью

Соответствует ли изменение цели проекта.
Нет ли ошибок (орфографических, грамматических, фактических).
Работает ли код (если он есть).
Читается ли текст легко.

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

Мы придерживаемся Кодекса поведения. Пожалуйста, ознакомьтесь с ним перед началом работы.

Есть вопросы?

Создайте Issue или напишите в Discussions. Мы на связи!

Ещё раз спасибо! Ваш вклад делает AI-сообщество сильнее.

Навигация: ← Awesome AI Handbook · Каталог