Содействие
Это руководство существует потому, что люди делятся тем, что они узнали. Каждый вклад делает его лучше для следующего человека, который разбирается, как работать с AI-агентами.
Зачем вносить вклад?
Section titled “Зачем вносить вклад?”Сфера развивается быстро. То, что работало полгода назад, может быть устаревшим. То, что вы узнали на прошлой неделе, может помочь кому-то завтра.
Ваш опыт важен. Независимо от того, используете ли вы AI-инструменты годами или только начали, у вас есть перспектива, которой у нас нет. Разные инструменты, разные языки, разные размеры команд, разные индустрии — всё это добавляет ценности.
Способы вклада
Section titled “Способы вклада”Быстрые улучшения (задача не нужна)
Section titled “Быстрые улучшения (задача не нужна)”- Исправьте опечатки или битые ссылки — Просто откройте PR
- Добавьте ресурс — Нашли отличную статью или видео? Добавьте на соответствующую страницу
- Уточните непонятные разделы — Если что-то запутало вас, улучшите это
- Обновите устаревшую информацию — Инструменты постоянно меняются
Большие вклады (сначала откройте задачу)
Section titled “Большие вклады (сначала откройте задачу)”- Новые страницы или разделы — Есть экспертиза, которую мы не покрыли? Давайте обсудим
- Примеры из практики — Реальные истории о том, что сработало (или нет)
- Переводы — Помогите сделать это доступным для большего числа людей
- Улучшения инструментов — Лучший поиск, навигация, доступность
С чего начать
Section titled “С чего начать”1. Найдите что-то для работы
Section titled “1. Найдите что-то для работы”Проверьте открытые задачи или найдите страницы, которые можно улучшить. Не знаете, с чего начать? Спросите в Discord.
Когда найдёте то, над чем хотите работать, оставьте комментарий к задаче, чтобы другие знали, что вы над ней работаете.
2. Настройте локально
Section titled “2. Настройте локально”# Fork и clonegit clone https://github.com/YOUR-USERNAME/agentic-path.gitcd agentic-path
# Установите зависимостиbun install
# Запустите dev serverbun devСайт работает по адресу http://localhost:4321.
3. Внесите изменения
Section titled “3. Внесите изменения”Создайте ветку, внесите правки, просмотрите локально.
4. Откройте PR
Section titled “4. Откройте PR”Отправьте ветку и откройте pull request. Включите:
- Что вы изменили
- Почему вы это изменили
- Любой контекст, нужный рецензентам
Руководство по стилю
Section titled “Руководство по стилю”Соответствуйте существующему тону:
- Прямой и практичный — Переходите к делу
- От второго лица — “Вы” а не “разработчик”
- Короткие абзацы — Максимум 3-5 предложений
- Реальные примеры — Показывайте, не только рассказывайте
- Без воды — Каждое предложение должно заслуживать своего места
Что мы хотим
Section titled “Что мы хотим”- Реальный опыт вместо теории
- Практические примеры, которые люди могут использовать
- Честные оценки (включая ограничения)
- Чёткую, просматриваемую структуру
Что мы не хотим
Section titled “Что мы не хотим”- Маркетинговый язык или рекламу продуктов
- Непроверенные заявления о “10x продуктивности”
- Сгенерированный AI-заполнитель
- Дублирование существующих тем
Структура страницы
Section titled “Структура страницы”Каждая страница требует frontmatter:
---title: Название вашей страницыdescription: Одно предложение для SEO и превьюsidebar: order: 1 # Позиция в сайдбаре (опционально)---Используйте чёткие заголовки, короткие абзацы и включайте раздел Ресурсы внизу для дальнейшего чтения.
Процесс проверки
Section titled “Процесс проверки”- Автоматические проверки — Сборка должна пройти
- Человеческая проверка — Обычно в течение недели
- Обратная связь — Мы можем предложить изменения
- Слияние — После одобрения мы смержим
Мы проверяем:
- Точность информации
- Соответствие существующему стилю
- Ценность для читателей
- Отсутствие битых ссылок или ошибок сборки
Сообщество
Section titled “Сообщество”Будьте прекрасны друг к другу
Section titled “Будьте прекрасны друг к другу”- Исходите из добрых намерений
- Уважительные разногласия приветствуются
- Помогайте новичкам чувствовать себя желанными
- Помните, что на другом конце есть человек
При предоставлении обратной связи
Section titled “При предоставлении обратной связи”- Будьте конструктивны, а не только критичны
- Предлагайте улучшения
- Признавайте, что хорошо работает
При получении обратной связи
Section titled “При получении обратной связи”- Не принимайте на свой счёт
- Задавайте уточняющие вопросы
- Можно не соглашаться — обсуждайте
Признание
Section titled “Признание”Ваш вклад признаётся через:
- Git history (постоянная запись)
- GitHub contributors page
- Release notes за значительный вклад
Есть вопросы?
Section titled “Есть вопросы?”- Быстрые вопросы — Discord
- Более длинные обсуждения — GitHub Discussions
- Сообщения об ошибках — GitHub Issues
Лицензия
Section titled “Лицензия”Внося вклад, вы соглашаетесь с тем, что ваш вклад будет лицензирован под MIT License.
Спасибо за помощь в создании этого. Каждое улучшение помогает кому-то лучше работать с AI-агентами.