Refactor/put project #296
Refactor/put project #296
Conversation
Eseas
requested review from
HiSeungmin,
K-KY,
jeongns2611,
kdh10806 and
taekminKwon
as code owners
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| contractNumber = project.getContractNumber(); | ||
| plannedStartDate = project.getPlannedStartDate(); | ||
| plannedEndDate = project.getPlannedEndDate(); | ||
| startDate = project.getStartDate(); // 시작일 |
There was a problem hiding this comment.
코드 리뷰를 진행해보겠습니다.
-
속성 제거:
contractNumber필드가Request와Response클래스에서 제거되었습니다. 이 변경이 불필요한 경우(예를 들어, 계약 번호가 여전히 필요하다면), 누락으로 인해 데이터 누락이나 링크 문제가 발생할 수 있습니다. 이 부분에서 요구사항 변경이나 기존의 기능이 여전히 필요한지 다시 확인해야 합니다. -
데이터 무결성: 만약
contractNumber를 제거하면서 비즈니스 로직이나 데이터베이스에서 관련 제약 조건이 있다면, 그런 제약이 이제 불필요해졌는지 확인해야 합니다. 관련 데이터가 제대로 처리되지 않을 위험이 있습니다. -
주석 처리: 클래스 속성에 대한 주석이 잘 작성되어 있습니다. 다만, 더 복잡한 비즈니스 로직이 있는 경우, 각 변수의 활용도 및 변화되는 맥락에 대해 추가적인 주석을 남기는 것이 좋습니다.
-
자료형 및 포맷: LocalDate는 잘 사용되고 있으나, 날짜와 관련된 다른 포맷이 자주 필요할 수 있습니다. 가능한 경우, 날짜 관련 함수를 추가하여 유연성을 높일 수 있습니다.
-
에러 핸들링: 프로젝트 업데이트 시 발생할 수 있는 오류를 적절히 처리하는지 확인해야 합니다. 예를 들어, null 체크나 데이터 유효성 검사를 통해 사용자에게 친숙한 에러 메시지를 제공하는 것이 중요합니다.
종합적으로, contractNumber 제거에 따른 영향 및 데이터 무결성 검토가 필요하고, 코드의 전반적인 안정성을 높이기 위해 추가적인 에러 핸들링이나 주석 강화를 고려해야 합니다.
| this.contractNumber = contractNumber; | ||
| this.plannedStartDate = plannedStartDate; | ||
| this.plannedEndDate = plannedEndDate; | ||
| this.startDate = startDate; |
There was a problem hiding this comment.
코드 리뷰 결과는 다음과 같습니다:
-
버그 위험:
contractNumber필드가 제거되었지만, 이 필드가 사용되던 다른 부분에서도 함께 수정이 이루어졌는지 확인해야 합니다. 만약 이 필드를 의도적으로 삭제한 것이라면, 프로젝트와 관련된 다른 클래스나 메소드에서contractNumber를 사용하는 부분이 없는지 점검이 필요합니다. -
정보의 일관성:
contractNumber가 제거되면서 해당 데이터와 관련된 검증 로직이나 비즈니스 로직도 함께 점검되어야 합니다. 만약 이 데이터가 중요하다면, 적절한 방식으로 데이터를 처리할 필요가 있습니다. -
주석 또는 문서화: 변경 이유나 의도를 명확하게 주석으로 남겨두는 것이 좋습니다. 다른 개발자들이 코드를 이해하는 데 도움이 될 것입니다.
-
유닛 테스트:
contractNumber가 삭제됨에 따라 관련된 유닛 테스트가 있는지 확인하고, 해당 테스트를 업데이트하거나 제거해야 할 것입니다. -
가독성 향상: 변수명이 충분히 의미를 나타내지 않을 경우,
ProjectType과 같은 변수명에 대해 더 명확한 이름을 사용하는 것이 좋습니다. 가독성을 높이기 위해 가능한 한 모든 변수명을 일관되게 사용하는 것이 중요합니다.
이 외에도, 전체적인 코드 구조와 다른 메소드나 클래스와의 관계를 고려하여 추가적인 피드백을 받을 수 있을 것입니다.
바로 MERGE하지 마세요! 검토 후 MERGE해야합니다!
✅ 최근 작업 주제 (하나 이상의 주제를 선택해주세요.)
🏆 구현 목표
ex)
bucket post 및 bucket list view 초기 구현
📋 구현 사항 설명 (작업한 내용을 상세하게 기록합니다.)
ex)
🔍 테스트 방법 (변경 사항을 확인하기 위한 테스트 방법을 기술합니다.)
ex)
npm test실행🛠️ 쓰이는 모듈
ex)
💬 기타 질문 및 특이 사항
ex) 백프 배포 nginx 검토