Code review (Worklog)
2020. 4. 9. 21:41ㆍBackend
- 주석은 최대한 사용하지 말라. 주석을 사용하는 것 보다 readability 가 좋은 코드를 작성하라
- Test code 는 99% 작성하라
- import 에 주의하라 wildcard(*) import 를 사용하지 말라
- Commit message 는 대문자로 시작, 마침표로 닫으라.
- 의미없는 Commit message 를 만들지 말라.
- 가능하면 Commit message 에 related issue number ex (#17) 를 붙여 tracking 하기 쉽도록 작성하라
- Commit message 는 한줄에 최대한 담을 수 있도록 작성하라.( 그렇지 않다면 commit 을 쪼개라)
- 의미없는 PR title 역시 만들지 말라.
- SDK 에서는 lombok 을 사용하는 것보다, AutoValue(Google) 를 고려하라(롬복은 코드를 해체 후 재조립한다)
- Documentation 이 필요하면 충분히 작성하라.
- Testcase 에 spock 보다 junit4 + Trust + Mockito 를 사용하는 것을 고려하라. 1 project, 1 language policy.
'Backend' 카테고리의 다른 글
A deep dive into Kubernetes controller (0) | 2020.11.27 |
---|---|
Nginx deep dive (0) | 2020.04.09 |
Apache Avro (0) | 2019.11.13 |
Abstract Factory pattern (0) | 2019.11.12 |
State pattern VS strategy pattern, what is the difference? (0) | 2019.11.10 |