pledge24 / futsalOnline

0 stars 0 forks source link

Feedback #28

Open bewisesh91 opened 3 weeks ago

bewisesh91 commented 3 weeks ago

우선, 프로젝트 구현하시느라 고생하셨습니다. 전반적인 피드백을 먼저 드리자면 다음과 같습니다.

동작하는 코드를 잘 작성하신 것 같아요. 대부분 깔끔하게 작성하셔서 코드를 직관적으로 이해하는 것이 문제가 없습니다. 다만, 주석이 너무 많습니다. 대부분의 로직에 주석이 달려있는데 불필요한 주석들은 오히려 코드의 가독성을 떨어뜨립니다. 삭제할 수 있는 것들은 최대한 삭제해주세요. 아마 프로젝트 간 서로의 이해를 위해 작성한 것으로 간주되오나 최대한 간결히 가독성 있게 코드를 짠다면 주석은 불필요한 것이 됩니다. 또한, 디버깅 로그를 찍기 위해서 만들어둔 코드들도 많은 것 같아요. 해당 코드들 역시 디버깅이 필요없는 상황이라면 삭제해주시면 좋을 것 같습니다. 다만 에러 관련 로그는 잘 남겨서 로직의 어디에서 문제가 발생했는지 확인할 수 있도록 처리하면 좋을 것 같습니다.

Validate 파일을 따로 작성하신 것 잘하신 것 같아요. 이외에도 필요한 기능이지만 덩어리가 커서 코드의 가독성을 떨어뜨리는 것이 있다면 분리해서 모듈화하는 것을 잘 시도해보면 좋을 것 같습니다.

커밋 내역을 보면 잘 작성한 것도, 그렇지 않은 것도 있는 것 같아요. 커밋 컨벤션을 정해서 잘 기록하고, 어떤 기능들을 작업 단위 별로 구분해서 구현했는지를 확인할 수 있도록 하면 좋을 것 같습니다.

이외에는 특별히 말씀드릴 만한 것이 없을 정도로 잘 하신 것 같아요.

pledge24 commented 3 weeks ago

안녕하세요. 이번 프로젝트 팀장 윤형석입니다. 우선, 저희 팀 프로젝트에 좋은 피드백 남겨주셔서 감사드립니다. 피드백 해주신 내용을 받아들여 앞으로 더 좋은 코드를 짜보도록 하겠습니다!

피드백해주신 내용들이 전부 맞는 말씀이지만 그럼에도 일부 피드백에 대해 조금 변명(?)을 해보자면 다음과 같습니다.

피드백 1. "다만, 주석이 너무 많습니다."

주석이 많은 이유는 언급하신 내용처럼 프로젝트 간 서로의 이해를 돕고자 일부러 많이 적게끔 하였습니다. '주석은 코드의 가독성을 해치지 않는 선에서 최대한 쓰자'라는 방향으로 작성하였고, 이렇게 적은 주석을 통해 비즈니스 로직의 이해도가 높아지니 다른 팀원이 작성한 코드를 재사용하거나, 제가 팀원들에게 코드 리뷰를 더 자주 할 수 있었던 것 같습니다. 그럼에도 불구하고, 튜터님이 보시기에는 가독성을 해치는 주석들이 많이 있을 것이라는 부분을 간과했던 것 같습니다. 다음부터는 마무리 작업에 주석을 간결하게 수정하는 작업을 추가하겠습니다!

피드백 2. "또한, 디버깅 로그를 찍기 위해서 만들어둔 코드들도 많은 것 같아요."

디버깅 로그는 있으면 튜터님들이 코드 테스트 하실 때 도움이 될 거라고 생각해서 일부러 남겨둔거였는데 그렇지 않았군요! 해당 부분은 수정하겠습니다.

피드백 3. "커밋 내역을 보면 잘 작성한 것도, 그렇지 않은 것도 있는 것 같아요."

이 부분에 대해서는 저도 아쉬운 부분이긴 합니다만, 팀원들에게 커밋 컨벤션까지 지키라고 하면 너무 힘들어 할까봐(분배한 기능 구현에도 힘들어 하시는 팀원들이 있었습니다.) 일부러 커밋 컨벤션을 정하지 않았습니다. 그렇다보니 브랜치 이름을 본인 이름으로 적거나 제작하는 기능과 관련없는 제목으로지어 커밋하는 경우가 다수 발생했던 것 같습니다. 프로젝트 역할 배정이랑 PR 관리는 제가 맡아서 커밋 내용은 저만 알면 되었던지라... 커밋 제목만 보고 이해하시기는 어려우셨을 겁니다. 튜터님 죄송합니다ㅠㅠ

피드백 주셔서 다시 한 번 감사드리고, 다음 프로젝트에서 더 좋은 코드로 더 성장한 모습 보여드리겠습니다...!