Чего я узнал из старого проекта GitHub, получившего 3000 звезд за неделю

1656670826 chego ya uznal iz starogo proekta github poluchivshego 3000 zvezd

от TOAST UI

SEdkr9OFX5pHVY-WKS7hCm5w7YiGHKBCRtul
ура! 5000 звезд!

Одинокий открытый исходный код

Мы разрабатывали проект Markdown WYSIWYG Editor в течение трех лет с его первым комитом в марте 2015 года. Я взялся за работу 30 декабря 2017, чтобы выпустить версию 1.0 и опубликовать ее в npm.

Тогда в хранилище было тихо, как воздух в офисе в конце года. Проблема публикуется раз в несколько месяцев и, кажется, пытается сказать: «Этот проект является открытым кодом». За три года он получил ровно 160 звезд GitHub, и было тяжело ждать запроса на получение.

Ничего неожиданного. Даже у Google и Facebook есть проекты с открытым кодом, не имеющие участников. Я предполагаю, что некоторые из вас, возможно, испытали разочарование, поскольку ваш драгоценный открытый код исчез. Кроме того, мы привыкли использовать GitHub как наше бесплатное хранилище Git. не мы ли?

Начиная с выпуска 1.0, я хотел, чтобы больше людей узнали этот проект. Я верил, что этот проект стоит больше, чем то, как он выглядел на тот момент. Я сделал несколько вещей, чтобы добиться этого, и в результате он получил 2000 звезд за 4 дня и 3000 звезд за неделю! Теперь он более 5500 звезд и полные проблемы и запросы на получение. Это произошло только через месяц.

fxEd5o4o2pUlorTc9inK0ShqcPRAeKbbbdIc
Да. Я пытался записать все, что казалось важным. ?

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

Хороший файл README получает звезды

Несмотря на то что мы разрабатывали наш редактор почти три года, он, кажется, никого не заинтересовал. Это было неизбежно, поскольку документы были плохи.

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

Файл README описывает сущность проекта. DEMO указывает, что он готов к использованию. Примеры должны быть первым шагом в разных требованиях. Учебное пособие должно помочь каждому начать.

Если вы пропустите любой из этих документов, пользователи откажутся от проекта. Выталкивание исходного кода не делает ваш проект проектом с открытым кодом.

Среди документов важнейшую роль играет README. Недостаточно просто перечислить несколько документов. Вы, я и большинство разработчиков ленивы. Большинство посетителей просто дважды прокручивают README и покидают, если им это не интересно. Итак, файл README должен дать причину, почему разработчики хотят ваш проект.

VN2sBeV4QJppueU7fffqSQKqaMausO9oEKBU
TOAST UI Editor README.md для 0.14.0 и 1.0.0

Давайте посмотрим, какую разницу принесло обновление файла README. Звезды GitHub – это практически не что иное, как закладки для посетителей. Но количество звезд GitHub говорит о том, насколько посетители заинтересованы в вашем проекте.

В нижеприведенных таблицах приведено количество звезд и уникальных посетителей, которые я зафиксировал до и после публикации TOAST UI Editor 1.0.

Не было добавлено никаких функций или обновлен дизайн. Были только обновления документов — в основном в файле README — и некоторый рефакторинг. Следующие цифры полностью получены в результате изменений в файле README.

T4viYEoUzOI5wh9T1yLa7R5jQqcvHdKwTyji
Количество уникальных посетителей и звезд. Обновление документов 30.12.2017
GaCXGWvuhf95YHVXrVFPp14YYvmZbBAOcbSR
Star/UV почти в 5 раз больше после обновления README

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

Перед обновлением файла README около 4% всех посетителей поставили звездочку. Удивительно, но после обновления файла README около 20% всех посетителей поставили звездочку. Обновив файл README, этот проект получил почти в пять раз больше звезд от посетителей!

Все говорят, что файл README важен. Но кто знал, что это будет иметь огромное значение? Я тоже был удивлен, увидев это. Если вы хотите иметь соавторов в проекте, вам следует написать красивый привлекательный файл README, чем что-либо другое.

В Google вы можете легко найти статьи о том, как создать хороший файл README. Также следует изучить файлы README в других проектах, указанных в Awesome Readme.

Наш проект имел около десяти посетителей в день. Если вы настойчиво работали над своими документами, пора сообщить людям о вашем проекте.

Конечно, будет лучше, если кто-то другой распространит информацию о вашем проекте вместо вас. Но начинать нужно самому. Если на ваш проект нет ссылок, он не будет отображаться в результатах поиска Google. Никто не узнает, что ваш проект существует.

Рассказывайте о своем проекте при любом случае

Ответьте на вопросы в StackOverflow и Quora. Общайтесь с людьми в группах Facebook. Отправьте ссылки на HackerNews и Reddit. И попросите рассылку разместить ваш проект.

CBGMjGs-i9eacEIZ8xKdCLs33H2rMdiez5YB
Расскажите, что такое ваш проект.

Вы также можете попросить сообщества помочь вам с вашим проектом, а также рассказать им о своем проекте.

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

Будьте активны в каждом сообществе, чтобы понять их. Знать сообщества полезно не только PR. То, что вы узнаете от них, также поможет вашим проектам.

Однажды продавец сказал мне:

«Вовлечение клиентов в вашу работу — лучший способ получить лояльных клиентов».

Я согласен с этим полностью. И я считаю, что мы должны делать то же самое для нашей работы.

Когда я обновил файл README, я попросил их просмотреть документ. И, к счастью, два человека направили запрос на получение после просмотра нового README. Я уверен, что они два интересуются нашим проектом больше, чем любые другие посетители. Бьюсь об заклад, что они также стали звездами нашего проекта.

2ZzKAhZ8Rkt6E30BX8wLuAqjrRS3DntIOwC2
Спасибо, ребята?

Изучите GitHub Explore

GitHub – лучшее место для привлечения ваших соавторов. Если ваш проект находится на GitHub, не смотрите слишком далеко и узнайте больше о нем. В верхней части GitHub вы всегда можете найти меню, которое следует за вами вместе с милым Octocat. Explore – это то, на что следует обратить внимание. Страница показывает разработчикам полезные и интересные open-source проекты.

Explore дает вам возможность продемонстрировать свой проект 24 миллионам пользователей GitHub. Вот почему вы должны поддерживать свой проект с открытым кодом GitHub.

Другие услуги также отличные, поэтому не поймите меня неправильно. Я использую BitBucket в течение очень длительного времени для личного управления личными проектами. GitLab также имеет очень хорошие функции, которые иногда работают для меня лучше, чем GitHub в последние годы. Однако проекты с открытым кодом должны поддерживаться GitHub, чтобы привлекать посетителей из Explore.

uKJBu0akQT8hAe-QGY9CiF6HV1zP34Ud1P5O
GitHub Исследуйте тенденции и темы

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

Когда вы откроете эту страницу, вы увидите вкладки «Коллекции», «Темы» и «Тенденции» — в каждой из них перечислены приятные проекты с открытым кодом. Среди них мы рассмотрим «Тенденции» и «Темы». Мы не можем помочь с коллекциями, поскольку их курирует GitHub.

В разделе «Тенденции» на главной странице «Обзор» показаны проекты, получившие наибольшее количество звезд на той неделе на всех языках. Подняться туда было бы очень тяжело.

v6YScBoXtOlnjtj8VIqkaKSKs43RaazIX2ak
Популярное Главное 1-е с 4761 звездой на этой неделе. Вам понадобится удача, чтобы занять это место.

Но не нужно сдаваться. Звужите язык и диапазон дат, а затем посмотрите на проекты низших рангов. Будет реалистичное число, к которому ваш проект также сможет достичь.

n4GCid-4SZ89d9Q9Mvs5T8Z5kT-El1Tp36XP
Популярный сегодня JavaScript занимает 25 место с 63 звездами сегодня. Вы тоже можете это сделать.

Сосредоточьтесь на посетителях в течение определенных дней, чтобы попасть в список, привлекая каждое сообщество, в котором вы находитесь. Если вы сможете собрать достаточное количество звезд, ваш проект также может быть в списке «Тенденции». Количество получаемых звезд зависит от языка проекта, дня недели и т.д.

Если вы выпустили новый проект или добавили к нему функции, самое время опубликовать его. Не разочаровывайтесь даже если ваш проект будет замечен в низком списке. Ваш проект все равно получит дополнительных посетителей. Воспринимайте раздел «Тенденции» как стимул для посетителей на основе вашего рейтинга.

xgjJzmJuEXJ0zEXIAAvJnpPkFePhQ2Ki2VoG
Уникальные посетители 10 января, 11 января

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

10 января – первый день – почти все посетители были из моих собственных сообществ. К счастью, маленькая часть GitHub.com в диаграмме показывает, что наш редактор был в списке «Тенденции». На следующий день, 11 января, GitHub приносил уже половину трафика. Это хороший стимул быть в списке трендов.

gSlAVbCTOm94GAUSM2uUt9fOGvpEuI7Ig5Yo
Уникальные посетители – 12 января.

На следующий день, 12 января, редактор был зафиксирован как №1 в тренде сегодня на всех языках. Большинство посетителей пришли из GitHub. С этого дня количество посетителей, пришедших с постов, которые я написал сам, значительно уменьшилось. Кроме того, с увеличением видимости посетители появлялись из неожиданных рефереров.

Fkh7LnVBf-xxiw07DBLx0f0k-kvnxept2yMr
Уникальные посетители – 13 января.

На следующий день, 13 января, больше всего посетителей пришло из GitHub. В этот день редактор записал 2000 звезд, четыре дня после размещения в сообществах. Несмотря на то, что с тех пор рост снизился, через месяц рейтинг «Тенденции этого месяца» все еще привлекает новых посетителей.

Постоянные посетители из GitHub Topics

Темы показывают проекты по порядку количества звездочек в теме.

Это значит, что если ваш проект наберет достаточно звездочек для размещения в теме, он все равно сможет привлекать посетителей к теме, даже если ваш проект не включен в список «Популярные».

Из списка Тем не так много посетителей, как из списка Популярные. Но оно того стоит.

-pGKqUjYfdTv3sQAsvGz8S2yi4qA5UPpF-op
Темы проекта на странице хранилища

Я видел много проектов, у которых нет тем. Посмотрите на изображение выше, чтобы увидеть, где можно настроить темы в своем проекте. Можно настроить любые темы.

Однако GitHub управляет списком под названием «Избранные темы». Поэтому лучше выбрать подходящие темы по рекомендованным темам, чтобы получить больше посетителей.

85HgGTwD9TESI-T21bArImtsKG6f4-zc4DS3
GitHub Ознакомьтесь со всеми рекомендованными и популярными темами

Кроме того, количество звездочек, которые необходимо указать наверху, значительно отличается в зависимости от тем.

Возьмите JavaScript как пример. Есть проекты размером с динозавра, такие как FreeCodeCamp (привет, ребята?), BootStrap, React, Vue и т.д. Это примерно в 100 раз усложняет попадание вашего проекта в этот список.

9hgwX85q-YLQbcHAO3sDmEH6JOgBe7tgm4XX
GitHub Исследуйте тему JavaScript. Ваш проект никогда не выиграет freeCodeCamp. ?

Наш редактор занимает 10 место в рейтинге Markdown Topic из 5,4 тыс. звезд. Посмотрите на темы и выберите темы, которые не слишком конкурентоспособны.

Лучшая одна строка для описания вашего проекта

3RufjyexWtRQbUFwJE6z2pVVvHWHIXB99FDY
Описание проекта на странице хранилища

Давайте снова найдем описание на изображении выше. Каково описание проекта для вашего проекта? Я написал описание нашего редактора как длинную версию названия (это плохая идея). Вы придумали свою линию? Тогда давайте посмотрим следующее изображение.

fN0S0mRMAk9ZnuJKr2YdiPiP4XTToB-9ILH3
Проект о тенденциях и списке тем

Так выглядит наш проект в разделе «Тенденции» и «Темы». Попытайтесь взглянуть на это с точки зрения посетителей. Есть организация, имя, фото участников и т.д. Единственная полезная информация, чтобы определить, щелкать или нет, это описание.

Описание должно быть лучшим одной строкой для описания вашего проекта.

Заключительное слово

Напишите документы. Будьте активны в сообществах. Используйте инструменты GitHub.

Советы, которыми я делюсь в этой статье, помогут вам улучшить свой проект как открытый исходный код (кроме того, чтобы получить больше звезд).

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

У меня была возможность написать эту статью, потому что бывшие сопровождающие (Shiren, JungHwan), которые сделали отличную работу для этого проекта. Я считаю, что этот проект уже имел такую ​​ценность, какую он имеет сегодня. И советы в этой статье помогли нам достичь остальных.

В прошлом месяце я получил действительно особый опыт разработчика. Я хотел бы поблагодарить семью TOAST UI и Dooray! Команда за вашу поддержку!

Если вы заинтересованы в TOAST UI Editor, я рекомендую вам попробовать Dooray! тоже. Он поставляется с редактором и является бесплатным для менее 100 соавторов. Разрешите TOAST UI Editor быть с вами?

Приятно работать вместе, Dooray!
Почта, средство отслеживания проблем и чата: каждый может легко опубликовать свою задачу и сотрудничать с гостями и участниками проекта.dooray.comnhnent/tui.editor
tui.editor — ?? Редактор WYSIWYG Markdown. Стандарт GFM + диаграмма и UML Extensible.github.com

Сначала опубликовано на Toast Meetup автором KyuWoo Choi?

Добавить комментарий

Ваш адрес email не будет опубликован.