나의 GitHub 관리법 - 깃허브 프로필, 깃허브 README.md 작성하기

깃허브는 인기있는 Git 저장소입니다. 그래서 수많은 프로그래머들은 깃허브 계정을 하나씩 가지고 있고, 프로그래머들 중 깃허브를 안쓰는 사람은 단언컨대 없을 것입니다. 이렇게 많이 쓰는 만큼 멋사같은 것에 지원할때나 입사 지원 할때 등등 깃허브 주소를 요구하는 곳들이 많아졌습니다. 그래서 매력적인 깃허브 계정을 만드는 것이 중요합니다. 이번에 한번 매력적인 깃허브 계정을 만들어보겠습니다.

---

간단한 유저네임, 나를 들어내는 프로필

저는 유저네임을 간단하게 하는 편입니다. 최대한 키보드로 빠르게 칠 수 있고, 특수문자나 숫자는 넣지 않습니다. 그래야 키보드로 칠때 빠르게 칠 수 있고, 기억하기도 쉽습니다.

 

또한 최대한 본명으로 하고 있습니다. 제가 본명으로 하는 이유는 혼동을 줄이기 위해서입니다. 오프라인에서 민성, 온라인에서 따로 클셀이라 하면 헷갈릴 가능성이 있기 때문에 웬만하면 본명으로 하고 있습니다.

 

여담으로 만약 같은 네임이 존재한다면 뒤나 앞에 dev, me 같은 개발자스러운 영어 단어들을 붙이는 것을 추천드립니다. 또한 Bio에는 직장을 (전 학생이기 때문에 빈칸으로 뒀습니다.), URL에는 프로필 노션을 링크해두었습니다.

 

그리고 프로필 사진이 중요한데, 나를 들어낼 수 있게 내 얼굴로 해두는게 좋습니다. 내 얼굴이 찍힌 사진을 넣는 것이 좋습니다. 그렇다고 너무 딱딱한 증명사진보다 부드럽고 캐주얼한 놀러가서 찍은 사진(여러명 있는것 말고, 혼자) 등등으로 해두는 것을 추천드립니다.

 

핀으로 대표 레포 6개를 고정해두기

내가 생각하는 대표적인 레포지스토리 6개를 골라 깃허브 프로필에 고정해두었습니다. 이 레포들은 내 깃허브에 들어가면 바로 보는 레포들인 만큼, 나를 나타내는 대표적인 레포들을 골라 고정해두는것을 추천드립니다. 또한 내가 기여했거나 참여한 프로젝트가 있다면 고정해두는 것도 좋습니다.

 

프로필 소개 페이지 만들기

내 프로필을 소개하는 것들을 적어 깃허브 메인에 걸어둔다면 효과적입니다. 그래서 한번 나를 소개하는 페이지를 만들어 깃허브에 걸어둬보도록 하겠습니다.

 

먼저, 깃허브 레포지스토리를 만들어줍니다. 만들때 레포지스토리 이름을 나의 깃허브 유저네임과 같게 만들어주셔야 합니다. 만들때 꼭 Add README.md를 체크해주시고 만들어주셔야 합니다. 그 후, 마크다운에 맞춰 원하는 대로 내용을 작성해주시면 됩니다. 만약 마크다운 문법을 모르신다면 여기를 봐주세요!

 

그리고 이런 거 한번 넣어보는 방법도 알려드리도록 하겠습니다. 아래 코드를 복사 후 유저네임 부분을 자신의 유저네임으로 수정한 뒤에 readme.md 파일에 넣으면 됩니다. 

 

Most Used Languages (많이 사용한 언어 순위)

<p><img align="center" src="https://github-readme-stats.vercel.app/api/top-langs?username=<username>&show_icons=true&locale=en&layout=compact" alt="<username>" /></p>

내 SNS 링크 뱃지 넣기

<a href="<URL>" target="_blank"><img src="https://img.shields.io/badge/<NAME>-<COLOR CODE(#빼서)>?style=flat-square&logo=<ICON>&logoColor=white"/></a>

사실 이 외에 많지만, 너무 많아 다 넣다간 글이 터질꺼같으므로,, 대표적인 2개만 올려두었습니다. 더 많은 뱃지들은 이 사이트를 참고해주세요. 또한 구글에서 깃허브 뱃지로 검색하면 많이 나옵니다.

 

readme.md 작성하기

개인적으로 Readme.md를 잘 작성했다고 생각되는 하루라이프 레포지스토리

다음으로는 레포지스토리의 소개글을 작성할 차례입니다. 나는 이 프로젝트에 대해 잘 알지만, 다른 사람을은 모르기 때문에 상세하고 자세히 적는게 좋습니다.

 

readme.md에는 프로젝트 이름, 소개(자세히 적으면 좋습니다.), 설치 방법, 라이센스를 적어주면 좋습니다. 설치 방법도 자세히 적어주면 좋습니다. 예를 들어 설치 환경같은 것이 있습니다. 또한 라이센스는 고민하시는 분들이 많던데, 전 보통 MIT 라이센스를 자주 사용하는 편입니다. MIT 라이센스는 상업적 이용/수정/배포 모두 가능하지만 책임은 안지는 라이센스입니다.

 

그리고 HTML/CSS를 사용해 만든 레포지스토리라면 깃허브 페이지를 사용해 정적 페이지를 만들어 체험을 할 수 있게 링크해두면 좋습니다.

 

혹시 어떻게 할지 잘 모르겠다면 템플릿을 쓰는게 편합니다. 여러 스타일의 템플릿들이 준비되어있습니다. 아래 링크를 접속해 여러 Readme의 템플릿들을 확인해보세요.

GitHub - matiassingers/awesome-readme: A curated list of awesome READMEs

또한 제일 중요한 부분인 오픈소스를 가져다 썼거나 도움을 받은 것이 있으면 꼭 언급하는게 좋습니다.

 

기타

만약 관심이 있거나 유용하게 사용한 레포에 스타를 해주면 좋습니다.

---

어떻게 끝맺음을 해야할지 모르겠는데.. 이상입니다!