Одинокий открытый исходный код
Мы разрабатывали проект Markdown WYSIWYG Editor в течение трех лет, с его первой фиксацией в марте 2015 года. 30 декабря 2017 года я приступил к работе, чтобы выпустить версию 1.0 и опубликовать ее в npm.
В то время в хранилище было тихо, как в офисе в конце года. Проблема публикуется раз в несколько месяцев, и кажется, что она пытается сказать: «Этот проект с открытым исходным кодом». За три года он получил ровно 160 звезд на GitHub, и трудно было ожидать запроса на вытягивание.
Не удивительно. Даже у Google и Facebook есть проекты с открытым кодом, у которых нет участников. Думаю, некоторые из вас, возможно, испытали разочарование, поскольку ваш драгоценный открытый исходный код превратился в пустоту. Более того, мы привыкли использовать GitHub в качестве бесплатного репозитория Git. Не так ли?
Начиная с версии 1.0, я хотел, чтобы об этом проекте узнали больше людей. Я считал, что этот проект стоит больше, чем он выглядел в тот момент. Я сделал несколько вещей, чтобы добиться этого, и в результате он получил 2000 звезд за 4 дня и 3000 звезд за неделю! Теперь у него более 5500 звезд и полные задачи и запросы на вытягивание. Произошло это всего за один месяц.
Я написал эту статью, чтобы поделиться своим опытом за последний месяц. Я также покажу вам записанные мной числа, когда это возможно. Я надеюсь, что это поможет вам наполнить ваш проект с открытым исходным кодом участниками.
Хороший файл README получает звезды
Несмотря на то, что мы разрабатывали нашего редактора почти три года, похоже, никого это не интересовало. Это было неизбежно, поскольку документы были скудными.
Даже для стиральной машины вам захочется один раз прочитать инструкцию. Вам следует предоставить еще больше документов для вашего проекта.
Файл README описывает суть проекта. ДЕМО показывает, что он готов к использованию. Примеры должны быть первым шагом в различных требованиях. Учебники должны помочь любому начать работу.
Если вы пропустите какой-либо из этих документов, пользователи откажутся от вашего проекта. Распространение исходного кода не делает ваш проект проектом с открытым исходным кодом.
Среди документов наиболее важную роль играет README. Недостаточно просто перечислить несколько документов. Вы, я и большинство разработчиков ленивы. Большинство посетителей просто дважды прокрутят README вниз и уйдут, если им это не интересно. Итак, в файле README должна быть указана причина, по которой разработчикам нужен ваш проект.
Посмотрим, какую разницу принесло обновление файла README. GitHub Stars на самом деле не что иное, как закладки для посетителей. Но количество звезд на GitHub говорит о том, насколько посетители заинтересованы в вашем проекте.
В таблицах ниже указано количество звезд и уникальных посетителей, зарегистрированных мной до и после публикации TOAST UI Editor 1.0.
Не было никаких добавленных функций или обновлений дизайна. Были только обновления документов - в основном в файле README - и некоторый рефакторинг. Следующие числа являются результатом изменений в файле README.
Было бы лучше, если бы у нас была запись с самого начала проекта. Но я просто записал цифры, чтобы проверить тенденции. Я ничего не могу с этим поделать. Итак, давайте просто посмотрим на цифры, и я оставлю это на ваше усмотрение.
Перед обновлением файла README около 4% всех посетителей ставили звездочки. Удивительно, но после обновления файла README около 20% всех посетителей поставили звезду. Благодаря обновлению файла README этот проект получил почти в пять раз больше звезд от посетителей!
Все говорят, что файл README важен. Но кто знал, что это будет иметь такое большое значение? Я тоже был удивлен, увидев это. Если вы хотите, чтобы в проекте участвовали участники, вам следует больше всего на свете написать красивый привлекательный файл README.
Вы можете легко найти статьи о том, как написать хороший файл README в Google. Также неплохо изучить README в других проектах, перечисленных в Awesome Readme.
Распространяйте информацию в сообществе
У нашего проекта было около десяти посетителей в день. Если вы много работали над своими документами, пора рассказать людям о своем проекте.
Конечно, было бы лучше, если бы кто-то другой рассказал о вашем проекте вместо вас. Но начинать надо самому. Если на ваш проект нигде нет ссылок, он не будет отображаться в поиске Google. Никто не узнает, что ваш проект существует.
Обсуждайте свой проект при любой возможности
Ответьте на вопросы о StackOverflow и Quora. Общайтесь с людьми в Группах Facebook. Разместите ссылку на HackerNews и Reddit. И попросите Информационные бюллетени разместить ваш проект.
Вы также можете попросить сообщества помочь вам с вашим проектом, а также рассказать им о своем проекте.
Но не спамите их вслепую. Сообщества и СМИ имеют разные личности. Распространение спама о вашем проекте без понимания каждого сообщества может привести к тому, что ваше сообщение будет удалено или просто проигнорировано. В худшем случае вас могут забанить в этих сообществах или ваш проект может получить плохую репутацию.
Будьте активны в каждом сообществе, чтобы понять их. Знание сообществ полезно не только для пиара. То, чему вы научитесь у них, также поможет вашим проектам.
Однажды продавец сказал мне:
«Вовлечение клиентов в вашу работу - лучший способ получить постоянных клиентов».
Я согласен с этим на сто процентов. И я думаю, что мы должны делать то же самое в нашей работе.
Обновляя файл README, я попросил их просмотреть документ. И, к счастью, два человека отправили запрос на перенос после просмотра нового README. Я уверен, что они вдвоем заинтересованы в нашем проекте больше, чем любые другие посетители. Бьюсь об заклад, они тоже стали звездой нашего проекта.
Изучить GitHub Изучить
GitHub - лучшее место для ваших участников. Если ваш проект размещен на GitHub, не уходите слишком далеко и сначала узнайте о нем больше. В верхней части GitHub вы всегда можете найти меню, которое сопровождает вас с помощью симпатичного Octocat. Explore - это то, на что стоит обратить внимание. На странице разработчикам показаны полезные и интересные open-source проекты.
Explore дает вам возможность продемонстрировать свой проект 24 миллионам пользователей GitHub. Вот почему вам следует поддерживать свой проект с открытым исходным кодом на GitHub.
Другие услуги тоже отличные, не поймите меня неправильно. Я очень давно использую BitBucket для управления личными проектами в частном порядке. GitLab также имеет действительно приятные функции, которые в последние годы иногда работают для меня лучше, чем у GitHub. Однако проекты с открытым исходным кодом должны поддерживаться на GitHub, чтобы привлекать посетителей из Explore.
Взгляните на то, что это за проекты, узнайте, какие положительные стороны этих проектов и как развивается текущая тенденция. Если вы еще не видели страницу "Обзор", пора ее проверить. Здесь вы можете узнать, что вам нужно сделать, чтобы ваш проект стал лучше.
Когда вы откроете эту страницу, вы увидите вкладки Коллекции, Темы и Тенденции - каждая из них содержит список хороших проектов с открытым исходным кодом. Среди них мы рассмотрим тренды и темы. Мы не можем помочь с Коллекциями, так как они курируются GitHub.
Поощрение посетителей от GitHub Trending
В разделе «Тенденции» на главной странице «Изучить» показаны проекты, получившие наибольшее количество звезд за неделю на всех языках. Подняться туда будет очень сложно.
Но тебе не нужно сдаваться. Сузьте язык и диапазон дат, затем посмотрите на проекты в нижних рангах. Будет реалистичное число, которого может достичь и ваш проект.
Сосредоточьтесь на посетителях в определенные дни, чтобы попасть в список, привлекая каждое сообщество, в котором вы участвуете. Если вы наберете достаточно звезд, ваш проект также может быть в списке «Тенденции». Количество получаемых вами звезд зависит от языка вашего проекта, дня недели и т. Д.
Если вы выпустили новый проект или добавили в него функции, сейчас самое время опубликовать его. Не расстраивайтесь, даже если ваш проект находится в самом низком списке. Ваш проект по-прежнему будет привлекать дополнительных посетителей. Думайте о разделе "Тенденции" как о стимуле для посетителей, основанном на вашем рейтинге.
Приведенная выше диаграмма представляет собой разбивку посетителей на GitHub Insight после того, как я распространял информацию в различных сообществах 10 января. Ссылка на сайты в GitHub Insight дает значения за двухнедельный период, поэтому вам нужно выполнить некоторые вычисления, чтобы получить нужные числа.
10 января, в первый день, почти все посетители были из моих общин. К счастью, небольшая часть диаграммы на GitHub.com показывает, что наш редактор был в списке тенденций. На следующий день, 11 января, GitHub уже приносил половину трафика. Это хороший стимул быть в списке трендов.
На следующий день, 12 января, редактор занял первое место в тренде сегодня на всех языках. Большинство посетителей пришли с GitHub. С этого дня количество посетителей, пришедших из сообщений, которые я написал сам, значительно уменьшилось. С другой стороны, по мере увеличения видимости посетители появлялись от неожиданных источников перехода.
На следующий день, 13 января, большинство посетителей пришло с GitHub. Редактор записал 2000 звезд в этот день, через четыре дня после того, как оно было опубликовано в сообществах. Хотя с тех пор рост снизился, месяц спустя Тенденции этого месяца все еще привлекают новых посетителей.
Постоянные посетители из тем GitHub
Темы показывают проекты в порядке количества звезд в теме.
Это означает, что как только ваш проект наберет достаточно звезд для включения в тему, он все равно сможет привлекать посетителей через эту тему, даже если ваш проект не включен в список тенденций.
Из списка тем не так много посетителей, как из списка «Тенденции». Но оно того стоит.
Я видел много проектов, в которых нет тем. Посмотрите на изображение выше, чтобы увидеть, где вы можете настроить темы в своем проекте. Вы можете настроить любые темы, какие захотите.
Однако GitHub управляет списком Избранные темы. Поэтому лучше выбирать соответствующие темы из избранных тем, чтобы привлечь больше посетителей.
Кроме того, количество звезд, которые необходимо указать наверху, значительно варьируется в зависимости от тем.
В качестве примера возьмем тему JavaScript. Есть такие проекты размером с динозавра, как FreeCodeCamp (привет, ребята 🙋), BootStrap, React, Vue и так далее. Это примерно в 100 раз затрудняет включение вашего проекта в этот список.
Наш редактор занял 10-е место в Markdown Topic с 5,4 тыс. Звезд. Взгляните на темы и выберите темы, которые не слишком конкурентоспособны.
Лучшая строчка для описания вашего проекта
Давайте снова найдем описание на изображении выше. Каково описание вашего проекта? Я написал описание нашего редактора как длинную версию заголовка (это плохая идея). Вы придумали свою линию? Тогда давайте посмотрим на следующее изображение.
Так выглядит наш проект в Trending и Topics. Попробуйте взглянуть на это глазами посетителей. Есть организация, имя, фотографии участников и так далее. Единственная полезная информация, позволяющая определить, нажимать или нет, - это описание.
Описание должно быть наиболее подходящей для описания вашего проекта отдельной строкой.
Заключительное слово
Напишите документы. Будьте активны в сообществах. Используйте инструменты GitHub.
Советы, которыми я делюсь в этой статье, помогут вам сделать ваш проект с открытым исходным кодом лучше (в дополнение к получению большего количества звезд).
Но сами по себе эти советы не могут сделать ваш проект популярным без ценности самого проекта. Я надеюсь, что эта статья поможет вам найти участников, которых заслуживает ваш проект.
У меня была возможность написать эту статью, потому что бывшие сопровождающие (Shiren, JungHwan), которые проделали большую работу для этого проекта. Я считаю, что этот проект уже имел ту ценность, которую имеет сегодня. И советы в этой статье помогли нам добиться остального.
В прошлом месяце я получил поистине особенный опыт в качестве разработчика. Хочу поблагодарить семью TOAST UI и Dooray! Команда за вашу поддержку!
Если вас интересует TOAST UI Editor, я рекомендую вам попробовать Dooray! тоже. Он поставляется с редактором и предоставляется бесплатно менее чем 100 соавторам. Пусть редактор TOAST UI будет с вами 🙏
Изначально опубликовано на Toast Meetup, автор: KyuWoo Choi 🌵
