포트폴리오 제출 깃허브 리드미(github readme)참고 예시

안녕하세요!

제가 학생 때에 비해, 요즘은 깃헙이 정말 대중화가 된 것 같습니다.

그래서 많은 대학생분들도 git을 사용하고계시고, 자연스럽게 신입공채 지원시에도 github url을 제출하게끔 되어있습니다.

 

깃허브에서 중요한 것은 무엇일까요?

단연 잘 정리된 readme일 것입니다.

아무리 개발자는 코드로 말한다지만, 리드미보다 코드를 먼저 읽는 개발자는 드물 것입니다. (사윤피셜)

 

그래서 특히 나를 최대한 어필해야하는 입사지원시 리드미를 다시한 번 잘 정리해야 할 것입니다.

깃허브가 무료가 된 뒤로 저는 repo가 전부 private이라 개판으로 쓰고있는데요...🤪

저도 조만간 오픈소스도 만들고, 깃헙 정리를 하고 싶습니다. 헤헤

 

 

리드미에 포함될 내용은 readme template 등으로 구글링하면 쉽게 찾아볼 수 있는데요,

그 중 하나를 소개합니다.

RichardLitt/standard-readme

 

참고하면 좋은 멋진 리드미 모음 repo입니다. 중간에 nhn의 토스트ui repo도 눈에 띄네요.

matiassingers/awesome-readme

 

 

 

 

네이버의 오픈소스 모음입니다. 각 프로젝트의 github이 링크되어 있습니다.

NAVER Open Source

 

 

보기 좋은 readme를 참고하되, 포트폴리오 제출용이라면 최대한 어필할 수 있도록 굳이 없어도 되는 내용을 첨부해도 될 것 같습니다.

아래와 같이 문서를 링크하는 식으로 개선일지를 첨부하거나 공부일지repo 등을 만드는 것도 좋겠죠.

너무 보여주기 식일까요? ㅋㅋㅋ 하지만 분명한건 정리를 하면서 공부가 많이 됩니다. 

naver/fe-news

 

 

 

👇 개발자 취업 준비하세요? 👇

기업에서 원하는 개발자 공통자질 세 가지 정리👩‍💻

👇 실컷 웃고싶다면? 개발자웹툰!👇

[웹툰] 어느개발자 정주행하기