Как GitHub помогает вам "опенсорсить"
@djuupВремя чтения: где-то 7 минут
Хеллоу, ворлд!
С вами телеграм канал Джун уронил прод и в этот раз вы обсудим GitHub и что он дает для вашего домашнего OpenSource.
В век высоких технологий большим делом считается обеспечение вклада в общее дело. Для нас, программистов, самый естественный способ "вложиться" - это написать код. Отличной площадкой для того, чтобы это сделать, является GitHub. У вас есть своя гениальная идея или вы захотели сделать вклад в популярную библиотеку или фреймворк? GitHub - отличное место для того чтобы показать себя, к тому же во множестве компаний при приеме на работу с радостью оценят вашу публичную активность. Но свои инструменты надо знать довольно хорошо. Так что же дает нам GitHub на сегодняшний день?
Неограниченное количество публичных репозиториев
В настройках в разделе Billing вы можете увидеть, что в бесплатный план входит неограниченное количество бесплатных репозиториев. Однако, для того чтобы получить приватные репозитории вы должны будете заплатить. В таких, редких, случаях, когда мне нужны приватные репозитории я прибегаю к использованию GitLab или BitBucket.
Git LFS (от $5 в месяц)
Если вы хотите хранить на гитхабе действительно большие файлы, например, фото или 3d модели, то вам придется воспользоваться специальным тулом, который гордо носит имя Git LFS (Large File Storage). Этот тул позволяет сохранять большие файлы немного отличным от обычного способом. Вы обозначаете тяжелый файл как отслеживаемый с LFS, а затем эта тула сама сохраняет файл на сервер LFS, а в ваш репозиторий кидает ссылку на этот файл. Ничего сложного, а ниже видео о том как это работает
При минимальном апгрейде аккаунта за $5 в месяц вы получите 1 датапак - это 50 GB/месяц пропускной способности и 50 GB на диске GitHub'a.
Шаблонные ответы
Если вам часто приходится отвечать на одни и те же вопросы, а создать FAQ - не вариант, то вам помогут шаблонные ответы, их вы можете найти в разделе настроек Saved replies.
Авторизация через OAuth GitHub
В наше время OAuth авторизация через вконтакте или фейсбук уже не модна, самое время для авторизации через гитхаб. Например, это нужно, когда вы хотите делать сборку с помощью Travis CI одного из ваших репозиториев, а потом вставить себе в репозиторий лейбл.
Пул реквесты
Не хитрая затея, которая позволяет прямо из интерфейса принять ваши изменения в удаленный репозиторий. Пул реквесты везде походят по разному, например, при создании пул реквеста google/guava специальный бот просит вас подписать лицензионное соглашение, бывают разные, интересные варианты.
Issues
Это не сложный бэклог задач. Интересно, что если в пул реквесте вы укажете номер issue, то в ней это отобразится.
Wiki
Для каждого из своих репозиториев вы можете сделать Wiki в которой разместите roadmap, опишите текущий статус и задокументируете проект.
GitHub Pages
Основываясь на содержимом репозитория вы можете создать GitHub Page, с помощью этой части сервиса вы можете публиковать свои статичные файлы и выдавать их как с обычного хостинга, вот пример того, что можете получиться на основании README.md файла. Вы можете бесплатно подключить свой домен и настроить https.
Insights -> Community
В этом разделе кладезь генераторов :) Из него вы можете создать README.md, описать на основании шаблона code of conduct (нормы поведения), описать процесс контрибьютинга (вклада в ваш проект) и, один из самых важных моментов, выбрать лицензию. GitHub имеет огромный перечень доступных вариантов, обязательно в будущем напишу о популярных лицензиях и их различих, подписывайтесь на канал @djuup.
Релизы
Куй железо не отходя от кассы. Именно так вы можете загружать релизы прямо на гитхаб и сделать это очень просто. Кликните в своем репозитории по releases, а затем Create a new release.
Графики
Последняя итересная фича на сегодня, про которую я хотел бы рассказать, находится в разделе Insights -> Graphs -> Traffic.
В этом разделе вы можете проследить количество клонирований вашего репозитория и количество его посетителей.
Забавные проблемы
Однажды, я столкнулся с проблемой при работе с GitHub. Предположим, что вы из интерфейса GitHub добавили себе лицензию в репозиторий, затем изменили Primary почту и удалили старую совсем. Спешу вас огорчить, что этот коммит не будет учтен в статистике, т.к. он сделан с "неведомой" почты, GitHub примерно так и скажет. Чтобы исправить проблему - вы можете добавить почту в аккаунт и её даже не нужно подтверждать.
Итоги
Пожалуй это всё о чем я хотел рассказать сегодня, если статья была для вас полезной, то подписывайтесь на канал Джун уронил прод, впереди много чего интересного!