깃에 코드 설명도 같이 올려야 하나요?

Question

4학년입니다. 인프런 강의 들으면서 따라한 코드 깃에 업로드 했습니다.이거 업로드 목적이 취업할때 제출하려고 하는건데 코드 설명도 적으시나요?저는 코드만 달랑 업로드해서 다시 코드설명 메인화면에 적어야되나 싶어서 여쭤봅니다.그리고 지금 스프링부트 jpa querlydsl거의 끝나가는데 aws 진행하면 될까요.스프링 쓰시는분들 사용하는 기술스택 또 뭐있을까요..

yjj8353 · Answer

보통 코드는 이 사람의 코딩 스타일이 어떤가? 레퍼런스를 제대로 지켰는지, 어떤 라이브러리를 썼는지만 확인하지 그거 다 까보는 사람은 별로 없습니다.그렇기 때문에 해당 프로젝트의 README.md 파일을 잘 작성해야 하는 겁니다.일반적으로 README.md 파일에 들어가면 좋은 내용들은프로젝트 동작과정을 담은 사진사용한 기술 스택자신이 담당한 범위레퍼런스등의 내용이 들어가야 합니다.

한식 · Answer

코드까지 본다면 윗분말대로 코딩컨벤션 체크정도..? 그 외에는 시간없어서 다 확인 못하지않을까요?

깃에 코드 설명도 같이 올려야 하나요?

2개의 답변

기타 목록