인기 있는 오픈소스 프로젝트 만드는 팁
(skerritt.blog)"네트워크 효과 : 사람들이 더 많이 찾게 될수록, 사용자가 더 많아지고, 더 많이 참여하고, 기능이 좋아져서 더 유명해지게 됨"
인기를 끌려면 어떻게 해야할까 ?
#1. 잘 설계된 README
- 맨 처음에 간결하게 설명할 것
ㅤ→ 뭘 하는 것인가?
ㅤ→ 내 문제를 해결하나 ?
ㅤ→ 내 문제를 경쟁자들보다 더 잘 해결하나 ?
ㅤ→ 어떻게 설치하지 ?
ㅤ→ 내가 알아야할 기본 명령들은 ?
ㅤ→ 도움 받으려면 어디로 가야하지 ?
1.1 프로젝트를 요약 설명하는 헤더 만들기
ㅤ→ 로고 : 로고는 Canva 같은 데서 GIF Logo 만들기
ㅤ→ 슬로건 : 한줄로 프로젝트를 설명. 깃헙의 Desc에 적용할 것
ㅤㅤ⇨ 눈에 확 들어오게
ㅤㅤ⇨ 왜 사용자가 이걸 필요로 하는지
ㅤㅤ⇨ 왜 다른 것들보다 이게 좋은지
ㅤㅤ⇨ 이해하기 쉽게
ㅤㅤ⇨ 예) hugo : The world’s fastest framework for building websites
ㅤ→ 뱃지 : 작은 이미지/링크인 것들로 프로젝트를 설명
ㅤㅤ⇨ 최근 활동 횟수, 다운로드수, 채팅방에 몇명이나, 사용하는 버전들, 라이센스.. 등
ㅤ→ 빠른 설치 : 쉽고 빠르게 설치하는 코맨드를 바로 보이게 표시
ㅤㅤ⇨ 이미 알고온 사람들은 빨리 사용해 볼수 있게
ㅤㅤ⇨ 도커/PIP 한줄로 설치 가능하다 같은 걸 최대한 초반에 표시
ㅤㅤ⇨ docker run -it --rm remnux/ciphey
ㅤ→ 퀵 링크들(필수 아님)
ㅤㅤ⇨ 웹사이트, 포럼, 문서, 설치가이드, 컨트리뷰션 가이드, 트위터 등
1.2 "What is This?" 프로젝트를 간결하게 설명하기
ㅤ→ 짧은 설명 + 프로젝트 동작을 보여주는 GIF + 사람들이 보고 싶어할 필수 기능
ㅤ→ 예) Starship : 두개의 컬럼으로 왼쪽에는 필수 기능 소개, 오른쪽에는 동작 GIF
ㅤ→ 모든 기능을 보여줄 필요 없음. 사용자들이 보고 싶어할 것만 리스트하고 이해하기 쉽게 설명할 것
1.3 "X vs Y" 경쟁자 들과 비교하기
ㅤ→ 왜 경쟁자들 대신 이 프로젝트를 선택해야 하는지 보여줘야 함
ㅤ→ 장점을 쉽게 볼수 있도록 할 것
ㅤ→ 린스타트업에서 "평균적인 사용자"보다 "얼리어답터"를 먼저 찾아야 하는 것과 같음
ㅤㅤ⇨ 더 좋은 기능을 가지고 있다면, 새로운 도구로 바꾸는 것을 꺼려하지 않는 사람들
ㅤ→ 경쟁자가 전혀 없거나 현재 솔루션들이 당신 것에 비해 엄청 복잡할때만 "평균적인 사용자"를 대상으로 하는게 맞음
ㅤ→ 가장 쉬운 방법은 주요 기능 비교 테이블을 만드는 것
ㅤㅤ⇨ 말보다는 숫자로 표시할 것
ㅤㅤ⇨ 동작을 GIF로 비교해서 보여주는 것도 좋음
1.4 훌륭한 문서 만들기
ㅤ→ 모든 문서를 README에 넣을 필요는 없음. 업데이트 및 검색이 어렵고 README를 보기 힘들게 만듬
ㅤ→ 위에서 설치 방법은 적었으니 추가로 보여줄 것은
ㅤㅤ⇨ 어떻게 실행하는 지
ㅤㅤ⇨ 어디서 문서를 찾을 수 있는지
ㅤㅤ⇨ 어떻게 지원을 받을 수 있는지
ㅤ→ 실행방법은 GIF로 보여주는 것도 좋음
1.5 기여 하는 방법과, 기여자들에게 감사를 보내고 및 환영하기
ㅤ→ 프로젝트에 기여하는 법
ㅤ→ 예전 기여자들에게 감사하기
ㅤ→ all-contributors 같은 봇을 사용하기
#2. 사람들이 원하는 것을 만들기
ㅤ→ 좋은 README는 사람들의 관심을 끌고, 그들의 "문제를 해결"하는 프로젝트는 사람들의 이야기를 이끌어 냄
2.1 문제가 먼저고, 제품이 그 다음
ㅤ→ 뭔가 제품을 만들기 위한 것이 아닌, 문제를 해결할 것
ㅤ→ "발전은 큰 도약뿐만 아니라 수백개의 작은 단계들에서도 옵니다"
2.2 문제와 함께 살기
ㅤ→ 문제가 없다면 효과적으로 문제를 해결할 수 없음
ㅤ→ 무작위 아이디어 생성보다, 자신의 삶에 존재하는 문제를 관찰하는 것이 훨씬 쉬움
ㅤ→ 문제가 있다는 걸 알게되면 두가지를 알게 되는 것. 실제로 문제가 있고, 다른 사람들도 가지고 있다는 것.
2.3 커뮤니티에서 문제 찾기
ㅤ→ 커뮤니티를 들여다 보면, 사람들이 자신들에게 주어진 문제를 노출하기도 함
ㅤ→ 사람이 많을수록, 더 많이 들을 수록 직접 생각하는 것보다 많은 아이디어들을 만들어 낼 수 있음
ㅤ→ 커뮤니티가 가지고 있는 문제를 해결하는 MVP(Minimum Viable Product)를 만들어 볼 것
ㅤ→ 커뮤니티와 공유하고 효과를 측정하고 더 좋게 만드는 것을 배우고 다시 만들거나 추가해서 개선할 것
#3. 입밖으로 꺼내기
ㅤ→ 잘 만들어도 공개하지 않으면 아무도 보지 않음
ㅤ→ 앞에서 커뮤니티를 이용했다면 다행히 그들은 이미 알고 사용할 것
ㅤ→ GitHub Star가 0에서 1이 되는 것은 어렵지만 10에서 100은 쉬움
3.1 커뮤니티에 공유
ㅤ→ Build, Measure, Learn 루프
ㅤ→ 첫번째 실제 릴리즈 때는 커뮤니티가 꼭 알게 할 것. 그들이 친구들에게 공유해 줄 것임
3.2 News Aggregators
ㅤ→ 원하는 Subreddit
ㅤ→ HackerNews ( 역주 : GeekNews 도! )
ㅤ→ Lobste.rs
3.3 Awesome List
ㅤ→ 토픽과 관련있는 리스트를 찾아서 PR 보내기
하루만에 깃허브 스타 500개 모은 이야기
https://black7375.tumblr.com/post/653140399088631808/
예전에 제가 쓴 글입니다.
홍보 전략을 중점으로 작성 했었어요.
홍보글 올리는 방식이나 시기, 개발방향과 마감시기를 정했던 방법등을 써놨습니다.
당연한 얘기이긴 합니다만.. 오픈소스의 README는 정말 중요합니다.
아무도 해결 못 하는/안 하는 문제를 해결하거나, 경쟁자를 뛰어넘는 놀라운 기능의 프로젝트라고 해도 README에 어떻게 적는 지에 따라 결과가 달라질 수 있어요.
국내뿐만 아니라 해외에도 알려지는 오픈 소스들이 많아졌으면 좋겠습니다.
요즘 가장 유명한 국내 개발자분들이 만든 오픈소스의 GitHub About 과 README 도 참고해 보세요.
swc : "Make the web (development) faster." swc is a super-fast compiler written in rust; producing widely-supported javascript from modern standards and typescript.
- https://github.com/swc-project/swc
fzf : fzf is a general-purpose command-line fuzzy finder.
- https://github.com/junegunn/fzf