Git & GitHub

README 관리 팁

하루 2022. 1. 31. 16:44

1. 구현 기능 목록화해서 정리하기

 

2. 설치 및 실행법 명시하기

출처: velog::sally

 

3. option / 프로젝트 구조 설명

  • 추가 기능이 있다면 작성하기
  • 프로젝트의 구조가 어떤 식으로 이루어졌는지?

 

4. 배포 주소 / 기능별 영상

읽는(보는) 사람을 고려하여 과제를 직접 배포하여 주소를 README에 걸어두거나, 작동하는 모습을 기능별로 영상화해서 걸어두기. (영상/움짤을 삽입하면 좋을듯)

모듈을 설치할 필요 없이 배포 링크와 내부 코드만 보고 확인할 수 있게!

 

5. 코드 설명, 과제 후기 적지 않기

개인 블로그에 적고 링크를 걸어두자. 장황해지면 읽지 않는다.

 

+ commit 관리

  • Commit 한 번에 끝내지 말고 세부 내용도 함께 적는다.
  • 진행 과정 보이게 4~10개 적기. 전략적으로 시간차를 두고 내가 이 프로젝트에 몰두했다! 라는 것을 어필 할 수 있다!
  • Comment message 일관성 지키기. 자주 쓰이는 커밋 컨벤션 확인하기
  • ~습니다 / 반말 / ~작업 중 말투 쓰지 않기

 

+ 포트폴리오, 이력서 관련

  • 내 사진 걸어놓기
  • 파일명, pdf로 이력서 만들기
  • 노션으로 pdf 파일 만들기 금지. 웹페이지와 pdf 사이즈의 차이 때문에 잘린다. 심하면 링크가 위아래 페이지로 잘린다. 사용할 거라면 결과물 확인 잘하기!
  • 합격을 위한 추천 단어, 플랫폼 이용하기 (원티드, 로켓펀치, 사람인)

 

 

 

출처/참고