GitHub에 남긴 기록은 사라지지 않습니다. 저장소, 커밋, PR, README는 모두 "이 사람이 어떻게 일하는가"를 보여주는 자료가 됩니다.
채용담당자나 팀원이 볼 수 있는 대표 기록은 세 가지입니다.
contribution graph는 활동의 흔적입니다. 양보다 중요한 것은 꾸준함과 실제 내용입니다.
매일 의미 없는 커밋을 만들 필요는 없습니다. 작더라도 실제로 고친 것, 배운 것, 정리한 것을 남기는 편이 좋습니다.
fix:, docs:, feat: 같은 메시지는 히스토리를 읽는 사람에게 친절합니다. 반대로 수정, 작업, asdf 같은 메시지는 나중의 나에게도 불친절합니다.
오늘 배운 conventional commits는 협업 규칙이면서 포트폴리오 글쓰기의 기본입니다.
PR 설명에는 코드 바깥의 맥락이 드러납니다. 무엇을 바꿨는지, 왜 바꿨는지, 어떻게 확인했는지 쓰는 습관은 팀 작업에서 큰 차이를 만듭니다.
GitHub에서 Issue, PR, README를 쓸 때는 GitHub Flavored Markdown, 줄여서 GFM을 씁니다. 마크다운 기본 문법에 GitHub 협업에 자주 쓰는 표현이 더해진 형식입니다.
자주 쓰는 것은 네 가지입니다.
#, ##로 내용을 구획한다-로 항목을 나눈다- [ ], - [x]로 할 일과 완료 여부를 표시한다예를 들어 PR 설명은 이렇게 짧게 정리할 수 있습니다.
## 변경 내용
- 로그인 실패 메시지를 더 구체적으로 바꿈
- 실패 상태를 테스트에 추가함
## 확인
- [x] pnpm test
- [ ] 브라우저에서 로그인 실패 화면 확인
| 항목 | 결과 |
| --- | --- |
| 단위 테스트 | 통과 |
| 수동 확인 | 대기 |
GFM을 잘 쓴다는 것은 글을 꾸미는 일이 아닙니다. 리뷰어가 변경 내용, 확인 방법, 남은 일을 빠르게 읽을 수 있게 정리하는 일입니다.
마지막으로 실제 GitHub에 push할 때 자주 막히는 인증 방식을 정리합니다.