프로젝트 공통 룰은 어떻게 정해야할까요?

Question

곧 팀 프로젝트를 진행하게 될 예정입니다! 백엔드 4명으로 구성되어서 진행할 것 같은데여아무래도 팀원 각자 지금까지 경험해온 코드 스타일이나 그런 부분들이 조금 다르다고 생각이 되더라구여개인적으로 팀장을 하고 싶은 욕심도 좀 있다보니 이런 고민이 드는데팀 공통 룰은 어떻게 보통 정하시나요 ?.. 예를 들면 예외처리라거나 ApiResponse를 할 때도 ResponseEntity를 사용한다거나생성자 &#64;Builder를 사용하는 등 이런 부분들은 그냥 맡은 부분에 따라 다르게 작성하시나요 ?최대한 그래도 통합을 하고 싶은데 이런 부분에서 어떻게 하셔왔는지 다들 경험이 궁금합니다!

Galneryus · Answer

그런 부분은 컨벤션을 만들어서 통일하시는게 좋을 것 같습니다

kenu,전독시 · Answer

이 문서가 도움 되시길개발 프로젝트 진행 순서새로운 서비스를 개발하기 위해서는 다음과 같은 순서를 고려합니다.기승전결기: 기획승: 개발 기반 구축전: 개발 진행결: 서비스 진화기: 기획구성원 모집기획(페르소나, 시나리오)화면 설계(wireframe, figma)데이터 설계(https://erdcloud.com)개발 기술 선택승: 개발 기반 구축프로젝트 저장소 생성(GitHub)개발환경 구축 및 공유프로젝트 기본 폴더 구조 작업코딩 컨벤션 공유(https://bit.ly/webconvention)기능별 샘플 코드, 테스트 케이스(optional)개발 서버 구축CI/CD 구성(GitHub Actions, Jenkins)빌드 결과 메시지 웹훅(slackbot, jandibot)전: 개발 진행점진적 개발(Sprint)기능 테스트사이드 이펙트 감지버그, 취약점 수정(SonarQube, ZAP)모니터링 기능 추가(Sentry, GA)결: 서비스 진화서비스 오픈 후 운영운영 데이터 시각화(DataViz)서비스 개선 기획ref오늘도 개발자가 안 된다고 말했다from: https://okdevtv.com/mib/devprocess

chytonpide · Answer

미리 협의를 통해서 문서화 한다음 진행하면 코드 일관성이 높아져서 좋습니다.반대로 안하면 지속적으로 코드베이스의 코드 품질이 저하될 수 있습니다.컨벤션을 정하는데도 상당한 시간이 소모될 수 있으니, 목적에 따라 어디까지 컨벤션을 정할 건지 결정 하셔야 합니다.단기간 작업해서 이후 유지보수 같은게 필요 없는 프로젝트면 간단한 것만 정하셔서 진행하시고장기 프로젝트로 멤버가 계속해서 교체되고 이후에도 계속해서 발전해 나갈 프로젝트라면 초반에 공을 들이시는게 더 좋을 수 있습니다.어노테이션 사용 같은건 거의 호불호 문제여서 컨벤션을 정할때 모두 참여시켜서 정해야지 사람들이 잘 지킵니다.정해진 컨벤션은 프레임워크를 사용해서 CI에서 강제하는게 가장 좋으나, 이것도 구성에 상당한 공수가 발생하니 단기 프로젝트라면 공수와의 트레이드오프를 생각해보셔야 합니다. ( 이런 류의 지식은 한번 해보면 쉬운데, 모르는 상태에서 구축하려면 상당한 리서치와 삽질이 필요하기 때문에...)설계적인 관점에서 지켜야하는건 constraints 로 따로 정리해 두셔도 좋을 것 같습니다.구체적인 예로는 - 컨트롤러 컨벤션 정하기 ex) 컨트롤러 베스트 프렉티스 메서드를 만드시고 do, don't 로 불랫 포인트로 정리하기,- API 스타일 정하기 ex) RestfulAPI 스타일로 한다. 각 RequestPayload, ResponsePayload 는 귀찮아도 메소드별로 DTO를 만든다. 등등- 의존방향 컨벤션 정의하기 ex) 컨트롤러 -> 어플리케이션 서비스 -> 도메인 (필요하다면 의존방향을 검사 하는 프레임워크 도입)- DTO타입의 명명법 정하기 ex) DTO, Dto, Data, Document 등등- 코드 커버리지 정하기 ex) 어플리케이션 서비스의 메서드는 무조건 테스트를 구현한다. 컨트롤러는 구현하지 않는다. (필요하다면 커버리지를 검사하는 프레임워크 도입)- 테스트 컨벤션 정하기 ex) 테스트 속도를 위해 @dirtiescontext를 사용하지 않고, entitymanager를 직접조작한다.

장독깨기 · Answer

아무래도 컨벤션을 정하고 따르는 것이 좋은데요,문서로 작성하는 것도 필요하지만,컨벤션에 맞춰 예시를 만들어 참조하면 작업하기 더 편할 것 입니다.

프로젝트 공통 룰은 어떻게 정해야할까요?

4개의 답변

Q&A 목록