- 이름을 통해서 의도 보이기
- 역할을 설명한다. -> 축약하지 말기!
- 연속적 숫자, info/data/the 같은 용어 (x)
-
개발 도구의 code format 기능 활용하기
- intellj : Ctrl+Alt+L
- 공백도 규칙이다. 불필요한 공백 라인 만들지 않기!
- space와 tab 섞지 않고, 1개만 사용
-> pull request 후 들여쓰기 확인하는 습관
-
반복하지 말기 = 중복 금지
-
의미 없는 주석 달지 않기
- 이미 이름으로 의도 표현시, 주석 추가 안한다.
= 의도가 표현되지 않는 경우, 주석을 단다.
-
값을 하드코딩하지 말기
- 하드 코딩 : 상수나 변수에 들어가는 값을 소스코드에 직접 쓰는 방식 (비추)
-
git commit 메시지를 의미있게 작성하기
-
README.md 파일에 작성하는 기능 목록을 구현하면서 업데이트하기!
-
README.md를 상세히 작성하기
- 마크다운으로 작성하여 프로젝트를 소개하는 문서이다.
위 규칙을 이용해서 기존 프로젝트를 수정해두어야겠다!