Руководства для проектов

Как получить звёзды GitHub для проекта с открытым исходным кодом

Чтобы получать звёзды GitHub, помогите заинтересованным разработчикам понять и опробовать ваш проект, а затем дайте им повод сохранить его. Начните с одного работающего примера и одного подходящего сообщества. Звёзды могут выражать интерес или служить закладками; они не показывают, сколько людей активно пользуются вашим ПО.

Редакция GitHubStart · Обновлено

Сделайте первое посещение репозитория полезным

Прежде чем делиться ссылкой, откройте репозиторий глазами человека, который о нём никогда не слышал. Первый экран должен объяснять проблему, целевую аудиторию и кратчайший путь к результату. Для визуального инструмента полезен снимок экрана; для библиотеки чаще полезнее небольшой пример входных и выходных данных.

Для вымышленного валидатора CSV фраза «Проверяйте экспорты CSV перед импортом в базу данных» информативнее, чем «Мощный набор инструментов для данных». Далее приведите пример некорректного файла, команду проверки и полученную ошибку.

  • Разместите назначение и работающий пример перед длинным перечнем возможностей.
  • Укажите требования к среде выполнения, этапы установки и известные ограничения.
  • Добавьте ссылки на лицензию, документацию и место для сообщений о проблемах.
  • Точно укажите темы репозитория, чтобы люди, интересующиеся этой темой, могли найти проект.

Найдите первых заинтересованных читателей

Выберите сообщество, где уже обсуждают решаемую вами проблему. Инструмент обработки данных на Python требует иного представления, чем браузерный инструмент дизайна. Опишите один конкретный сценарий и поясните, по чему хотите получить обратную связь. Сообщите, что сопровождаете проект, и сначала прочитайте правила публикаций сообщества.

Начните с небольшого эксперимента: улучшите README, поделитесь одним запускаемым примером в подходящем месте и ответьте на возникшие вопросы. Если читатели не могут установить проект, исправьте это до добавления новых каналов. Повторная публикация одной ссылки не заменяет решения проблем первого знакомства с проектом.

Просите звезду после того, как принесли пользу

Достаточно короткой необязательной строки после быстрого старта: «Если проект вам полезен, можете поставить звезду репозиторию, чтобы найти его снова». Инструкции по установке, документация и поддержка должны быть доступны независимо от того, поставил ли человек звезду.

GitHubStart предлагает публичный каталог для поиска проектов и обмена. Вы можете добавить публичный репозиторий без входа в GitHubStart, просматривать другие проекты и решать, какие поддержать. Звезду по-прежнему нужно ставить вручную, войдя в GitHub. Добавление репозитория не гарантирует определённого числа звёзд или ответной звезды.

Ведите еженедельный журнал наблюдений

Записывайте дату, внесённое изменение, место публикации, полученные вопросы и исправления. Сопоставляйте звёзды с практическими показателями: успешными установками, воспроизводимыми проблемами и повторными вкладами участников. Всплеск после публикации — это корреляция, а не доказательство, что каждая новая звезда пришла именно с неё.

Например, если пять читателей спрашивают, как настроить токен, перенесите инструкцию по настройке выше примера. Поделитесь исправленным примером с этими читателями вместо очередного общего объявления о запуске.

  • Неделя 1: проверьте быстрый старт в чистой среде.
  • Неделя 2: поделитесь одним сценарием использования и ответьте на отзывы.
  • Неделя 3: опубликуйте исправления и объясните изменения.
  • Неделя 4: сохраните канал, давший полезные обсуждения, и пересмотрите остальные.

Частые вопросы

Как получить первые 100 звёзд GitHub?

Считайте 100 ориентиром, а не обещанным результатом. Начните с пригодного к использованию проекта, понятного README и заинтересованных читателей. Те же действия подходят и при 5, и при 500 звёздах; необходимое время зависит от аудитории и проекта.

Можно ли поставить звезду репозиторию GitHub без входа в аккаунт?

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

Означает ли больше звёзд больше пользователей?

Не обязательно. Человек может сохранить репозиторий на потом, не устанавливая его. Отслеживайте использование и обратную связь отдельно от числа звёзд.

Источники