12/20 프론트엔드 온보딩 인턴십 내용 정리.
오늘은 세션의 중요 내용 중 하나는 면접관이 구직자의 레퍼지토리를 확인할 때 무엇을 중점적으로 보는지, 지양해야하는 것은 무엇인지에 대한 주제였습니다.
특히, 레퍼지토리 리드미의 중요성을 많이 강조하셨는데 이 리드미 파일 하나로 이 프로젝트의 첫 인상이 많이 좌지우지된다고 하셨고 무엇이 리드미 파일에 기술되어야하는가에 대해 배웠습니다.
지금까지 수행했던 프로젝트나 이번 기술과제의 리드미 파일에도 나름 필요한 정보를 기술했다고 생각했지만 어떤 부분을 좀 더 보완해야할지 생각해볼 수 있는 시간이었습니다.
그 중 확실히 필요성을 느꼈던 부분은 아래와 같습니다.
1. 레퍼지토리의 구성
컴포넌트와 함수 등이 어떤 폴더 구조로 정리되어 있는지 명확하게 기술해 면접관 또는 동료들이 빠르게 원하는 코드를 찾아보고 이해할 수 있도록 기술할 필요가 있습니다.
2. nvm 버전 기술
당연한거지만 지금까지 필요성을 느끼지 못했는데 만약 누군가가 프로젝트를 본인의 컴퓨터에 설치해 살펴보자한다면 레퍼지토리 소유자는 원활한 작동을 위해 nvm 버전에 대한 정보를 기술해야할 필요가 있습니다.
리드미 파일에 정보를 잘 기술하는 것 외에 신경을 써야할 부분이라면 아래의 사항들이 있습니다.
1. 프로젝트 배포 후 모든 기능 및 페이지가 의도한대로 동작하는지 확인.
2. 컴포넌트의 효율적인 구조 및 책임 설정.
책임의 중복 방지, 유기적으로 잘 연결되었는가, 재사용 가능성 여부, 외부의 변화에 유연한지 점검 반복.
3. 코드는 읽는 사람입장에서 작성. 읽는 사람이 이해가 최대한 잘 되도록 작성되어야 함.
4. 커밋 메세지는 최대한 구체적으로 작성. 특히, 그룹 프로젝트일 경우 일관성을 가진 포맷의 커밋 메세지 형태를 논의할 필요가 있다.
5. 모든 변수명은 최대한 알아들을 수 있도록 명명.
data, info, res 등 금지) 왜냐하면 모든 변수는 data이므로..
6. 기술 과제일 시 요구사항의 제한을 잘 지키자.
금지된 라이브러리 등 사용 가능한 기술 재확인!
7. 일관성있는 코드규칙 적용.
따옴표 혹은, 쌍따옴표 사용, 인덴트 간격 동일하게 등) 아마 린트나 프리티어 꼭 언제나 적용하라는 말씀으로 이해함.
참 기본적이지만 지키기에는 또 막상 쉽지 않은 규칙들인것 같습니다.
앞으로 어떤 프로젝트를 수행하든 이 기록을 다시 보면서 위 규칙을 습관화할 수 있도록 해야겠습니다!
PS. 본 내용의 출저는 원티드 프리온보딩 프론트엔드 인턴십의 세션 내용입니다.