깃허브(GitHub) 관리

이 글은 Sujin Lee의 깃허브(GitHub)로 취업하기를 참고했습니다. 

 

1. 프로필

username

유명한 개발자는 본명 대신 닉네임 또는 별칭으로 불리기도 한다. 하지만 나와 같은 컴공 대학생은 다른 사람들이 나를 기억할 수 있게 내 이름을 더 많이 드러내고 알려 한다. 따라서 username은 gildong본명을 사용해 영어로 만든다.

 

이메일 주소

이메일 주소가 너무 튀지는 않는지 확인한다. 영어자판에서 한글이름을 타이핑한 아이디(예:rlfehd), 의미가 너무 자극적이거나 부정적인 의미를 내포하는 아이디(예: myloveexo)는 피해야 한다. 아예 취업용 계정을 따로 만들어 사용하는 편이 좋다. 이메일 계정 역시 실명으로 만들어야 한다. 영문 이름이 Gildong Hong일 경우, gildong.hong, gildonghong등으로 만들 수 있다. 만약 원하는 계정을 사용할 수 없다면, 아이디 끝에 dev, tech등을 붙여 지원하는 직무와 얼리는 계정을 만든다. (예: gildong.tech)

 

프로젝트 

프로필 페이지 최상 단에 있는 pinned repositories를 클릭해 최소 3가지 이상 프로젝트를 고정시킨다. 기여한 오픈 소스 리퍼지토리가 있다면 반드시 메인 화면에 고정시킨다.

 

2. 1일 1커밋

풀이 듬성듬성난 마당보다 잘 가꿔진 푸른 잔디밭이 더 보기 좋다. 초록색으로 꽌 찬 커밋 히트맵(commit heatmap)은 당신의 열정과 성실함을 보여준다. 개발자는 매일마다 새로운 것을 배우고 성장해야 한다. 이제부터라도 매일 조금씩이라도 코딩하고 꾸준히 커밋하는 습관을 길러보자. "잔디(커밋)"를 하나 둘씩 심다보면 코딩에 대한 자신감은 물론 성장하는 나의 모습을 보며 큰 성취감을 느낄 수 있다.

 

3. 올바르게 커밋하기

커밋 이력은 내가 개발자로서 일하는 모습과 태도를 보여주는 객관적인 지표이다. 논리적이고 체계적으로 일하며, 꾸준하게 발전하고 있다는 모습을 보여줘야 한다.

 

커밋 단위

커밋은 최종 목표를 달성하기 위한 이정표와 같다. 초보자가 가장 많이 하는 잘못된 습관 중 하나는 한꺼번에 모든 파일과 코드를 커밋하는 것이다. 작은 단계로 커밋하여 코드 개발 과정을 가시적으로 보여줘야 한다.

 

매서드 리팩터링이나 새로운 매서드 또는 클래스를 추가할 때마다 커밋한다. 실험이나 성능 튜닝을 할 때도 각 단계별로 커밋한다. 소스 코드 변경 내역이 없을 때는 커밋하지 않는다.

 

커밋 메시지 작성법

자신만의 커밋 메시지 작성 원칙을 정하고 일관성있게 커밋해야 한다. 

 

커밋 메시지는 제목, 본문(선택), 꼬리말(선택) 세 부분으로 작성한다.

Type: 제목(Title)

본문(Body)

꼬리말(Footer)

 

제목

커밋 메시지 제목은 docs: Edit README.md to include New Features Use-Cases와 같이 작성한다.

 

제목은 타입라벨을 맨 앞에 붙어 타입(Type) : 제목 형식으로 작성한다. 각 타입 라벨은 아래와 같다.

feat: 새로운 기능을 추가할 경우

fix: 버그를 고친 경우

docs: 문서 수정한 경우

style: 코드 포맷 변경, 세미 콜론 누락, 코드 수정이 없는 경우

refactor: 프로덕션 코드 리팩터링

test: 테스트 추가, 테스트 리팩터링 (프로덕션 코드 변경 없음)

chore: 빅드 테스크 업데이트, 패키지 매니저 설정할 경우 (프로덕션 변경 없음)

 

제목의 처음은 동사 원형으로 시작하고 첫 글자는 대문자로 작성한다.

"Fixed", "Added", "Changed" 등 과거 시제가 아닌 "Fix", "Add", "Change" 명령어로 시작한다. 총 글자 수는 50자 이내며 마지막에 마침표(.)를 붙이지 않는다.

 

본문(선택)

본문은 커밋의 상세 내용을 작성한다. 제목과 본문 사이에 한 줄 비운다. 본문은 한 줄에 72자 이내로 작성한다. 한 줄을 띄워 문단으로 나누거나 불렛을 사용해 내용을 구분한다.

 

꼬리말 (선택)

꼬리말에는 이슈 트래커 ID를 추가한다.

 

4. 프로젝트 소개 글 작성하기

프로젝트 문서는 음식 레시피와 같다. 레시피를 보는 대부분은 처음 음식을 만들거나 요리에 익숙하지 않는 이들이다. 조리법은 물론 재료, 준비물 등이 자세하고 완벽하게 설명되어 있어야 초보자들도 제대로 된 음식을 만들 수 있다. readme.md 역시 처음 보는 이들을 위해 프로젝트 모든 것을 적어놓는 레시피와 같다.